Examples and harnessing docs use APIs that no longer exist
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 74/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- rust
- 領域
- documentation, testing
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Rust
- スター
- 335
- フォーク
- 26
- 平均マージ
- 1日 50分
- マージ済み PR（30日）
- 12
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
intel/tsffs のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 86/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
bug UI
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
wardian-app/Wardian#1746 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
jlcodes99/cockpit-tools#3125 ·
メンテナーはふだん 2 日以内に返信
-
bug user-sprint
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
Vondor/KassenSturz#967 ·
メンテナーはふだん 1 日以内に返信
-
area/ci
難易度 1/5 1時間未満 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
[BUG] Incremental sync warns "no stored highest_uid" on every round for folders with no new mailオープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
rustmailer/bichon#411 ·