Examples and harnessing docs use APIs that no longer exist
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 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 分钟
- 30 天内合并 PR
- 12
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 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 ·