Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

[correctness][documentation-ambiguity][printf documentation and help] printf help advertises the explicitly unsupported -v option

オープン 初心者向け
  • 何か問題がありますか？
#665 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
75/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
go
領域
cli, documentation

調査の方向性

使用法の行は builtins/printf/printf.go の189行目付近にあり、-v を拒否するコードのすぐ隣にあります。SHELL_FEATURES.md の42行目付近を確認し、-v がサポートされていないことを確かめてください。使用法テキストから [-v var] の部分を削除し、tests/scenarios/cmd/help/ の下に help printf を実行して -v が含まれていないことを確認するシナリオを追加してください。このシナリオが合格し、ヘルプ出力で -v が案内されなくなれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Generated by the rshell behavior correctness scanner.

  • Contract: BEH-009
  • Classification: documentation-ambiguity
  • Impact: low
  • Target: printf documentation and help
  • Scanned commit: 514d1cb8188fda6b1accca5955dfab3b0e8aa34a

help printf prints a usage line advertising [-v var], while SHELL_FEATURES.md explicitly rejects -v. This directs users toward an unsupported invocation. The temporary scenario checks a usage line with that option removed; the finding is a documentation conflict, not a claim that one exact help layout is mandatory.

Contract sources
  • [SHELL_FEATURES.md:42](https://github.com/datadog/rshell/blob/514d1cb8188fda6b1accca5955dfab3b0e8aa34a/SHELL_FEATURES.md#L42): Supported surface; Bash/GNU behavior applies where no intentional divergence is documented.
  • [builtins/printf/printf.go:189](https://github.com/datadog/rshell/blob/514d1cb8188fda6b1accca5955dfab3b0e8aa34a/builtins/printf/printf.go#L189): User-visible help advertises printf [-v var] format [arguments].
Implementation references
  • [builtins/printf/printf.go:189](https://github.com/datadog/rshell/blob/514d1cb8188fda6b1accca5955dfab3b0e8aa34a/builtins/printf/printf.go#L189): --help emits Bash usage including -v, immediately beside code rejecting -v.

Fixture setup

Use a fresh empty working directory for each run. Build from /workspace/repo first. No fixture files are needed. Run the CLI and reference commands with that directory as cwd.

Reproducer

help printf

Commands used:

  • GOENV_VERSION=1.26.3 timeout 300s go build -o /tmp/zz_correctness_scan_rshell ./cmd/rshell
  • /tmp/zz_correctness_scan_rshell --allow-all-commands --allowed-paths "$PWD" -c 'help printf '
  • GOENV_VERSION=1.26.3 timeout 300s go test ./tests -run '^TestShellScenarios$/^.$/zz_correctness_scan_printf_help_surface$' -count=2 -v -timeout 300s

Verification

  • Reproduction runs: 4
  • Reference: Two fresh CLI runs and two scenario runs captured identical help text. Expected help must exclude unsupported -v; exact replacement wording is unspecified. Bash is not an oracle for this intentional -v divergence.
  • Temporary test: tests/scenarios/zz_correctness_scan_printf_help_surface.yaml (removed after evidence capture)
  • Suggested regression-test location: tests/scenarios/cmd/help/

Fingerprint: 1ab3bb5a33aa40ef0898b7a9a899e5cc56a73e99c9886bb4b2bac144c7ea6f0d

主要言語
Go
スター
31
フォーク
3
平均マージ
2日 9時間
マージ済み PR（30日）
14

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

DataDog/rshell のほかの issue

DataDog/rshell の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。