Skip to content

Document global options (-r, --enc and --timeout)#4479

Closed
keks wants to merge 2 commits intomasterfrom
feat/docs-global-opts
Closed

Document global options (-r, --enc and --timeout)#4479
keks wants to merge 2 commits intomasterfrom
feat/docs-global-opts

Conversation

@keks
Copy link
Copy Markdown
Contributor

@keks keks commented Dec 11, 2017

Closes #4432.

Is this what you had in mind or do you want more detail?

@keks
document global options -r, --enc and --timeout
1721588 
License: MIT
Signed-off-by: <keks@cryptoscope.co>
@keks keks requested review from a user and kevina December 11, 2017 17:20
@ghost ghost assigned keks Dec 11, 2017
@ghost ghost added the status/in-progress In progress label Dec 11, 2017
@ghost
Copy link
Copy Markdown

ghost commented Dec 11, 2017

Ideally they'd also show up in the block below that summary line:

OPTIONS

  -c,   --config string - Path to the configuration file to use.
  -D,   --debug  bool   - Operate in debug mode.
  --help         bool   - Show the full command help text.
  -h             bool   - Show a short version of the command help text.
  -L,   --local  bool   - Run the command locally, instead of using the daemon.
  --api          string - Use a specific API instance (defaults to /ip4/127.0.0.1/tcp/5001).

These ^ are the global options that have been documented so far.

@kevina
Copy link
Copy Markdown
Contributor

kevina commented Dec 12, 2017 •
edited
Loading

@keks is there a reason we don't list these options under the Root cmds.Command in core/commands/root.go (here https://github.com/ipfs/go-ipfs/blob/master/core/commands/root.go#L87)

kevina
kevina suggested changes Jan 5, 2018
View reviewed changes
Copy link
Copy Markdown
Contributor

@kevina kevina left a comment •
edited
Loading

Choose a reason for hiding this comment

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

These options should also be listed under the Root cmds.Command in core/commands/root.go (here https://github.com/ipfs/go-ipfs/blob/master/core/commands/root.go#L87) unless there is a good reason not to.

If I understand how things work this should add them under the summary as @lgierth requested.

@whyrusleeping whyrusleeping mentioned this pull request Jan 20, 2018
Closed
@whyrusleeping
Copy link
Copy Markdown
Member

whyrusleeping commented Jan 22, 2018

@magik6k do you think you could handle getting this one ready to go?

@Kubuxu Kubuxu removed the status/in-progress In progress label Mar 9, 2018
@magik6k magik6k self-assigned this Mar 9, 2018
@magik6k
correct root command synopsis
f08e85c 
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
@keks keks requested a review from Kubuxu as a code owner March 9, 2018 21:21
@ghost ghost added the status/in-progress In progress label Mar 9, 2018
@magik6k
Copy link
Copy Markdown
Member

magik6k commented Mar 9, 2018

Looks like the options are now documented in ipfs --help, I changed the synopsis to reflect those

@gammazero
Copy link
Copy Markdown
Contributor

gammazero commented Jul 2, 2025

Issue #4432 is closed and documentation is present in help text.

@gammazero gammazero closed this Jul 2, 2025
@gammazero gammazero deleted the feat/docs-global-opts branch July 2, 2025 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Kubuxu Kubuxu Awaiting requested review from Kubuxu

1 more reviewer

@kevina kevina kevina requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

status/in-progress In progress

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document cmdkit's global options

8 participants

@keks @kevina @whyrusleeping @magik6k @gammazero @GitCop @momack2 @Kubuxu