Document the 19 undocumented configuration attributes

Đang mở Phù hợp với người mới
#438 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
82/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
rust
Lĩnh vực
documentation

Hướng nghiên cứu

So sánh các chú thích cấu hình trong src/lib.rs dòng 385–468 với docs/src/config/common-options.md. Đọc các phần tùy chọn hiện có, sau đó ghi lại 19 thuộc tính được liệt kê và nêu thời gian chờ mặc định. Công việc hoàn tất khi common-options.md đề cập đến từng tùy chọn được liệt kê và thời gian chờ mặc định.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Where

Problem
Not mentioned anywhere in docs/README/examples: debug_log_libafl, shutdown_on_stop_without_reason, quit_on_iteration_limit, save_{timeout,solution,interesting,all}_execution_traces, execution_trace_directory, execution_trace_pc_only, heartbeat, heartbeat_interval, symbolic_coverage, symbolic_coverage_system, symbolic_coverage_directory, debuginfo_download_directory, debuginfo_source_directory, debug_info, last_exception_processor_number, last_stop_reason. The default timeout is not stated.

Impact
Source coverage and execution tracing have no user documentation.

Suggested fix
Add sections to common-options.md from the lib.rs doc comments.

Related
#65

Status
Reported by static code review at 79972db; not yet re-verified line by line. Found by reading the code; not reproduced under SIMICS.

Ngôn ngữ chính
Rust
Star
335
Fork
26
Merge trung bình
1 ngày 50 phút
Pull request đã merge (30 ngày)
12

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của intel/tsffs

Tất cả issue của intel/tsffs

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.