Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Remove the deprecated spellings, and --output-file, which no tool uses

Đang mở
  • Có gì không ổn?
#173 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
cpp
Lĩnh vực
cli, documentation, testing

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

chore severity/minor

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

  1. Make --output-file and output_file warn like the other deprecated spellings.
  2. In CHANGELOG.md, announce the release that removes them all.
  3. 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.
  • ctest passes.

From the technical debt register (docs/quality/technical-debt.md, D6).

Ngôn ngữ chính
C++
Star
5
Fork
4
Merge trung bình
1 giờ 2 phút
Pull request đã merge (30 ngày)
74

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của CoreTrace/coretrace

Tất cả issue của CoreTrace/coretrace

Issue tương tự

Thêm issue về C++

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.