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

Document global options #2583

Open
RichardLitt opened this issue Apr 19, 2016 · 5 comments
Open

Document global options #2583

RichardLitt opened this issue Apr 19, 2016 · 5 comments
Labels
help wanted Seeking public contribution on this issue topic/docs-ipfs Topic docs-ipfs

Comments

@RichardLitt
Copy link
Member

timeout is a global option that can be passed to the CLI and to the HTTP API. It is referenced in a few places, like in ipfs diag net --help, but it isn't clear there that it is global, and it may seem that it is only relevant for those subcommands (like diag net). There should be a mention of global options, somewhere in the CLI man (and in the HTTP API docs, but we can get to that later).

The obvious place would be at the bottom of ipfs --help. What do you think?

@whyrusleeping
Copy link
Member

I think that global options should probably be printed for every commands --help output. Since they affect every command.

@RichardLitt
Copy link
Member Author

This should also apply for proto. CF https://github.com/ipfs/http-api-spec/pull/52/files#r55575516.

Also, I think 'encoding'?

@atomgardner
Copy link
Contributor

atomgardner commented Apr 19, 2016

@whyrusleeping

I think that global options should probably be printed for every commands --help output. Since they affect every command.

But aren't they "supposed" to be specified before the subcommands? e.g.: ipfs -L name resolve Qmfoo or ipfs -C /foo/bar add -w baz.

@atomgardner
Copy link
Contributor

@Stebalien, what's the diff for your edit? obviously I have no recollection of writing the response.

@Stebalien
Copy link
Member

Adding a newline between the quote and your comment, IIRC.

@daviddias daviddias added docs and removed docs labels Oct 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Seeking public contribution on this issue topic/docs-ipfs Topic docs-ipfs
Projects
None yet
Development

No branches or pull requests

5 participants