Skip to content
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 4 commits into from
Mar 5, 2019
Merged

Improve CLI help pages #6013

merged 4 commits into from
Mar 5, 2019

Conversation

AuHau
Copy link
Member

@AuHau AuHau commented Feb 22, 2019

Improved CLI help pages with updated synopsis and information about logging support in IPFS.

@AuHau AuHau requested a review from Kubuxu as a code owner February 22, 2019 01:51
core/commands/root.go Outdated Show resolved Hide resolved
core/commands/root.go Outdated Show resolved Hide resolved
@Kubuxu
Copy link
Member

Kubuxu commented 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]>
@AuHau
Copy link
Member Author

AuHau commented Feb 22, 2019

You are welcome!
All fixed.

@Kubuxu Kubuxu added the RFM label Feb 25, 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 ghost assigned Stebalien Mar 1, 2019
@ghost ghost added the status/in-progress In progress label 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> ...",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Kubuxu LGTY?

Copy link
Member

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?

@Stebalien Stebalien merged commit 5f11ed7 into ipfs:master Mar 5, 2019
@ghost ghost removed the status/in-progress In progress label Mar 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants