Improve CLI help text and examples#352
Merged
Merged
Conversation
- Add a Long description to the root command documenting all supported store location formats and the '|' failover-group syntax - Fix prune usage line: extra args are indexes, not files; document the confirmation prompt and --yes - Fix mount-index help: a state file is only written when --cor-state-save is given; SIGHUP reload doesn't 'restart the server' - Restructure the extract description into paragraphs - Clarify misleading flag descriptions (verify/prune 'target store', repeatable --listen, cat --length 0, chunk --start in bytes) and make --ignore/--ignore-chunks wording consistent between cache and chop - Add examples: cat with offset/length, make with custom chunk sizes to STDOUT, verify -r, writable/HTTPS chunk-server, writable index-server, multi-index prune - Add missing Long texts for manpage and chunk
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Review of the help screens of all commands in
cmd/desync/, fixing inaccuracies and improving descriptions, flag texts, and examples.Incorrect help text fixed
pruneusage line saidprune <index> [<file>..]— the extra arguments are indexes, not files. The description now also mentions that the operation is destructive and that a confirmation prompt is shown unless--yesis given.mount-indexclaimed a<name>.statefile is always written on termination.WriteState()is a no-op unless--cor-state-saveis set, so the text now reflects that (and that it also triggers on SIGHUP). Also reworded "reload without needing to restart the server" — mount-index isn't a server.chophad the typo "index(s)".Missing documentation added
desync --helphad no long description and the store location syntax wasn't documented anywhere in the CLI, even though nearly every command takes-s. It now lists all supported forms (local path,http(s)://,s3+http(s)://,gs://,sftp://,ssh://), multi-store ordering, and the|failover-group syntax.manpageandchunklong descriptions;chunknow explains it's a dry-run useful for tuning chunking parameters beforemake.Clarity/consistency
extract's 17-line single-paragraph description restructured into paragraphs (basic use,-k, seeds, invalid-seed handling); its two seed flag descriptions no longer start with a capital letter unlike all other flags.cachedescription implied-cwas optional, but the command errors without it.verify -s/prune -ssaid "target store" (now "local store to verify"/"store to prune"),--listenis repeatable,cat -l 0reads to the end,chunk -Sis in bytes.--ignore/--ignore-chunkswording unified betweencacheandchop.catwith offset/length,makewriting the index to STDOUT with custom chunk sizes,verify -r, writable and HTTPSchunk-server, writableindex-server, multi-indexprune.No behavior changes, only help/usage strings.