Add picotool help topics - #342
Conversation
|
maybe worth renaming "device selection" at least the heading/docs (not the help option) to indicate that it has other stuff like reboot |
I have updated it to "Options for Target Device Selection and Rebooting" |
|
Perhaps the "Show general help or help for a specific command" now ought to say "Show general help, or help for a specific command or topic". |
Move device selection options into a separate picotool help device-selection command, rather than appearing in every help output Also add a family-ids topic to list available family IDs (fixes #305)
Add docs for `version` and remove ALLOWED_MISSING_COMMANDS "Post load actions" -> "Load options" set/get -> get/set Fix white-label -s option not showing up Fix otp permissions docs
gen_help_txt.sh tidyups Add topic mention to picotool help docs Missing comma in block devices docs
Fixes things like --family <family_id> appearing on separate lines Also ensures short and long options are shown in the help output
…tout Also ensure all lines end in full-stops
…ool help uf2` etc
503fe3f to
226098d
Compare
| otp Commands related to the RP2350 OTP (One-Time-Programmable) Memory | ||
| partition Commands related to RP2350 Partition Tables. | ||
| uf2 Commands related to UF2 creation and status. | ||
| otp Commands related to the RP2350 OTP (One-Time-Programmable) Memory. |
There was a problem hiding this comment.
| otp Commands related to the RP2350 OTP (One-Time-Programmable) Memory. | |
| otp Commands related to the RP2350 OTP (One-Time-Programmable) memory. |
|
|
||
| Use "picotool help <cmd>" for more info | ||
| TOPICS: | ||
| device-selection Options for Target Device Selection and Rebooting |
There was a problem hiding this comment.
The selection of Capital letters here feels a Bit Random? 🤔
There was a problem hiding this comment.
It’s just title case
| The normal output is this format: | ||
| ```text | ||
| $ picotool version | ||
| picotool v2.3.0 (Linux, GNU-12.2.0, Release) |
There was a problem hiding this comment.
Probably not worth it, but I guess all these v2.3.0 versions could be updated to v2.3.1 ?
There was a problem hiding this comment.
I’ll merge in develop so they get updated, otherwise the CI readme check will fail
| 2.3.0 | ||
| ``` | ||
|
|
||
| Or with an incompatible version (e.g. 2.4.0 with version 2.3.0), it will exit with error code `ERROR_INCOMPATIBLE` (-3): |
There was a problem hiding this comment.
It earlier says "to check a newer picotool is backwards compatible with an older version", so perhaps it doesn't make sense to try checking against a not-yet-released picotool version, and would be better to check against an older version that picotool 2.3.0 isn't backwards-compatible with?
| -s, --set <key> <value> | ||
| Set config variable name to new value |
There was a problem hiding this comment.
Outside the scope of this PR, but if picotool config allows you to set the value of a particular config key, it'd probably also be useful if it allowed you to get the value of a single config key?
| Specify the load address when comparing with a BIN file | ||
| <offset> | ||
| Load offset (memory address; default 0x10000000) | ||
| -r, --range <from> <to> |
There was a problem hiding this comment.
Why does the help-text for the erase command below not also use this new single-line -r, --range <from> <to> format?
| Specify the OTP page storing the AES key (IV salt is stored on the next page) | ||
| <page> | ||
| OTP page (default 29) | ||
| --otp-key-page <page> |
There was a problem hiding this comment.
Does this command fail if given an otp-key-page but not an otp JSON filename? (And similarly does it fail if given an otp JSON filename but not an otp-key-page?)
And presumably the --sign command fails if not given a <signing_key>?
Hmm, is the <signing_key> option of the encrypt command the same thing as the <key> option of the seal command? (If they are, perhaps it makes sense to rename seal's option for consistency?)
| Specify file type (elf) explicitly, ignoring file extension | ||
| Partition Table Options | ||
| --sign <keyfile> | ||
| The file name |
There was a problem hiding this comment.
Should "The file name" here be "Signing Key file (.pem)" ?
Hmm, should the <bootloader> option's "The file name" text be clarified too?
3 participants
The device selection options have got quite long, so move them into a separate
picotool help device-selectioncommand, rather than appearing in every help outputAlso add a family-ids topic to list available family IDs (fixes #305)
Also makes various improvements to the help output.