Remove the deprecated spellings, and --output-file, which no tool uses
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 48/100
- Issue 类型
- 重构
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- cpp
- 领域
- cli, documentation, testing
调研方向
Start with the deprecated option and key handling in src/App/Config.cpp, src/App/ToolConfig.cpp, and include/ctrace_defs/types.hpp; review the tests and docs/configuration.md section named in the issue. Update the warning for --output-file and output_file, then remove the listed compatibility paths, their tests, and the Legacy Compatibility section. Update CHANGELOG.md for the removal release and run ctest; removed keys and options should be rejected.
由索引模型根据 Issue 内容生成。
描述
ctrace still accepts spellings that were replaced, each with its own code path, tests and documentation:
| Spelling | Replaced by | Where |
|---|---|---|
--async, runtime.async |
--jobs, runtime.jobs (#158) |
src/App/Config.cpp:151, src/App/ToolConfig.cpp:729 |
--ipc=socket |
--ipc=standardIO (#83) |
include/ctrace_defs/types.hpp:26-41 |
Root invoke and input, stack_analyzer legacy keys, stack_analyzer.include_dirs and defines, tools.ctrace_stack_analyzer, tools.stack_analyzer |
The canonical sections (#87) | src/App/ToolConfig.cpp (applyLegacyRootInvokeAndInput, deprecated); docs/configuration.md, "Legacy Compatibility" |
--output-file (config output.output_file, API output_file) is in a worse state: its help text says "Legacy output path; no current tool writes to it" (src/App/Config.cpp:72). It is accepted, without any warning, and does nothing.
To do
- Make
--output-fileandoutput_filewarn like the other deprecated spellings. - In
CHANGELOG.md, announce the release that removes them all. - In that release, remove them, with their tests and the "Legacy Compatibility" section of
docs/configuration.md.
Acceptance
- After the removal, a removed key is rejected with the unknown-key diagnostic that names the allowed keys, and a removed option is rejected by the CLI.
ctestpasses.
From the technical debt register (docs/quality/technical-debt.md, D6).
- 主要语言
- C++
- 星标
- 5
- 派生
- 4
- 平均合并
- 1 小时 4 分钟
- 30 天内合并 PR
- 71
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
CoreTrace/coretrace 的其他 Issue
-
documentation severity/minor
难度 1/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
chore good first issue severity/minor
难度 1/5 1 小时以内 新手友好度 90/100
维护者通常 1 天内回复
-
build severity/minor
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
build good first issue severity/minor
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
test: add unit tests for ctrace::RunDirectory可能已有人在做 @tecnolgd 今天认领。 未关闭good first issue test
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
查看 CoreTrace/coretrace 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
-
1 type: problem 2 scope: firmware 3 good first issue
难度 2/5 1-3 小时 新手友好度 65/100
SpaceTeam/STS1_COBC_SW#511 ·
-
documentation good first issue
难度 2/5 1-3 小时 新手友好度 82/100
imaaiagent/fumi#3 ·
-
General perf
难度 2/5 1-3 小时 新手友好度 72/100
NVIDIA/TensorRT-LLM#20236 ·
维护者通常 1 天内回复
-
bug
难度 1/5 1 小时以内 新手友好度 88/100
E3SM-Project/mam4xx#603 ·
维护者通常 1 天内回复