The top-level "picotool help" doesn't show that the subcommands also take arguments

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
静か
技術スタック
cpp
領域
cli

調査の方向性

README.md とトップレベルの picotool help 出力の実装から始め、issue に示されている picotool help partition create およびその他の subcommand の help 形式と比較してください。トップレベルの synopsis を更新して、subcommand が引数を受け取ることが分かるようにし、その結果の help 出力を partition、uf2、otp、bdev について確認してください。

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

説明

As you can see in https://github.com/raspberrypi/picotool/blob/master/README.md when you run picotool help the output includes lines like:

    picotool partition info|create
    picotool uf2 convert|combine|info
    picotool otp get|set|load|white-label|permissions|dump|list
    picotool bdev ls|mkdir|cp|rm|cat|format

This makes it look like e.g. picotool partition create doesn't take any extra arguments, when it actually does - in the picotool help partition create output you can see a fuller synopsis:

    picotool partition create [--quiet] [--verbose] <infile> <outfile> [-t <type>] [[-o
                <offset>] [--family <family_id>]] [<bootloader>] [-t <type>] [[--sign
                <keyfile>] [-t <type>] [--no-hash] [--singleton] [--no-btstack-flash-bank]]
                [[--abs-block] [<abs_block_loc>]]

So perhaps it worth modifying the picotool help output to include e.g.

    picotool partition info|create [partition-subcommand-arguments]
    picotool uf2 convert|combine|info [uf2-subcommand-arguments]
    picotool otp get|set|load|white-label|permissions|dump|list [otp-subcommand-arguments]
    picotool bdev ls|mkdir|cp|rm|cat|format [bdev-subcommand-arguments]

? (Which will hopefully encourage people to run picotool help partition so that they can find out more about the partition-subcommand-arguments 😉 )

主要言語
C++
スター
1k
フォーク
195
平均マージ
14日 8時間
マージ済み PR（30日）
3

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

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

raspberrypi/picotool のほかの issue

raspberrypi/picotool の issue をすべて見る

似ている issue

C++ の issue をもっと見る

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

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