Document the 19 undocumented configuration attributes

未关闭 适合新手
#438 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
82/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
rust
领域
documentation

调研方向

将 src/lib.rs 第385–468行中的配置注释与 docs/src/config/common-options.md 进行比较。阅读现有的选项章节,然后记录列出的19个属性并注明默认超时时间。当 common-options.md 涵盖每个列出的选项和默认超时时间时,即表示完成。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Rust
星标
335
派生
26
平均合并
1 天 50 分钟
30 天内合并 PR
12

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

intel/tsffs 的其他 Issue

查看 intel/tsffs 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。