-
-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve CLI help pages #6013
Merged
Merged
Improve CLI help pages #6013
Conversation
This file contains 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
Kubuxu
reviewed
Feb 22, 2019
Kubuxu
reviewed
Feb 22, 2019
Thanks! I've left some comments. |
License: MIT Signed-off-by: Adam Uhlir <[email protected]>
License: MIT Signed-off-by: Adam Uhlir <[email protected]>
License: MIT Signed-off-by: Adam Uhlir <[email protected]>
You are welcome! |
Kubuxu
approved these changes
Feb 22, 2019
Users should use --offline instead of --local and --stream-channels is sent by default (and doesn't do anything as far as I can tell)... License: MIT Signed-off-by: Steven Allen <[email protected]>
ghost
assigned Stebalien
Mar 1, 2019
Stebalien
reviewed
Mar 1, 2019
@@ -29,7 +29,7 @@ const ( | |||
var Root = &cmds.Command{ | |||
Helptext: cmdkit.HelpText{ | |||
Tagline: "Global p2p merkle-dag filesystem.", | |||
Synopsis: "ipfs [--config=<config> | -c] [--debug | -D] [--help] [-h] [--local | -L] [--api=<api>] [--offline] [--cid-base=<base>] [--upgrade-cidv0-in-output] [--encoding=<encoding> | --enc] [--stream-channels] [--timeout=<timeout>] <command> ...", | |||
Synopsis: "ipfs [--config=<config> | -c] [--debug | -D] [--help] [-h] [--api=<api>] [--offline] [--cid-base=<base>] [--upgrade-cidv0-in-output] [--encoding=<encoding> | --enc] [--timeout=<timeout>] <command> ...", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Kubuxu LGTY?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, --stream-channels
is an internal option isn't it?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Improved CLI help pages with updated synopsis and information about logging support in IPFS.