Skip to content

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

Description

@lurch

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 😉 )

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions