Remove the deprecated spellings, and --output-file, which no tool uses
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 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分
- マージ済み PR(30日)
- 71
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 日以内に返信