Examples and harnessing docs use APIs that no longer exist
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ó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 74/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, testing
Hướng nghiên cứu
Start by comparing the named examples and documentation snippets with the current APIs and constants in src/interfaces/fuzz.rs and the harness headers. Review the listed locations in examples/manual-example/fuzz.simics, docs/src/harnessing/, docs/src/tutorials/kernel-module/running-the-fuzzer.md, docs/src/config/common-options.md, and harness/README.md. Update stale names, values, and snippets; done when the examples match the current APIs and initialize the documented size values correctly.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Where
- https://github.com/intel/tsffs/blob/79972db9c63eba3ac8a1ce348264eee2005b2b16/examples/manual-example/fuzz.simics#L17 (
set_generate_random_corpus), https://github.com/intel/tsffs/blob/79972db9c63eba3ac8a1ce348264eee2005b2b16/examples/manual-example/fuzz.simics#L34 (start_with_maximum_size, 3 args) docs/src/harnessing/closed-box.md:62,70(fuzz.start(...),start_with_maximum_size; says two APIs, there are four)docs/src/tutorials/kernel-module/running-the-fuzzer.md:83-84(magic_start/magic_stop)docs/src/harnessing/compiled-in.md:78,89,197(HARNESS_STOP is magic 4 not 2;HARNESS_STOP_INDEX;size_t *size_ptr)harness/README.md:9-11; header doc examples leavesizeuninitialiseddocs/src/config/common-options.md:101,333(broken snippets)src/interfaces/fuzz.rs:66,154doc comments mentionstart_with_max_size
Problem
Docs and the manual example refer to removed names and wrong magic numbers.
Impact
Users copying the examples get errors or silently wrong harnesses.
Suggested fix
Rename to start_with_buffer_ptr_size_ptr / _size_value / _size_ptr_value, generate_random_corpus, magic_start_index/magic_stop_indices; fix the snippets.
Related
#65
Status
Confirmed for the manual example; the rest reported by static review. 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
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.
- Có Dockerfile hoặc tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của intel/tsffs
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 86/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Maintainer thường phản hồi trong vòng 1 ngày
Issue tương tự
-
bug UI
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
wardian-app/Wardian#1746 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
jlcodes99/cockpit-tools#3125 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
bug user-sprint
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Vondor/KassenSturz#967 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
area/ci
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 62/100
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG] Incremental sync warns "no stored highest_uid" on every round for folders with no new mailĐang mởbug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
rustmailer/bichon#411 ·