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.

Sign up for GitHub

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

Jump to bottom

Please document all command-line options in --help #2284

Closed
rrthomas opened this issue Mar 11, 2021 · 0 comments · Fixed by #2747
Closed

Please document all command-line options in --help #2284

rrthomas opened this issue Mar 11, 2021 · 0 comments · Fixed by #2747
Labels
docs
Milestone
1.7 release

Comments

@rrthomas
Copy link

Describe the bug

--help does not document all command-line options. This breaks bash-completion, as well as confusing the user.

See scop/bash-completion#507 (review)
@rrthomas rrthomas mentioned this issue Mar 11, 2021
Merged
rrthomas added a commit to rrthomas/bash-completion that referenced this issue Mar 27, 2021
@rrthomas
feat(jq): support all command-line options
677d152 
The options are not all listed by --help, so look in the man page to find a
nearly complete list (I hope!). Neither the man page nor --help mentions --help
or --version; I have not looked elsewhere to see if there might be yet more.

Guard against the possibility of jq being fixed in future by testing to see if
its --help output contains “--help” and using it if so, otherwise, use the
hard-coded list; see
jqlang/jq#2284
scop pushed a commit to rrthomas/bash-completion that referenced this issue Mar 28, 2021
@rrthomas @scop
feat(jq): support all command-line options
08e0302 
The options are not all listed by --help, so look in the man page to
find a nearly complete list (I hope!). Neither the man page nor --help
mentions --help or --version; I have not looked elsewhere to see if
there might be yet more.

Guard against the possibility of jq being fixed in future by testing to
see if its --help output contains “--help” and using it if so,
otherwise, use the hard-coded list; see
jqlang/jq#2284
scop pushed a commit to scop/bash-completion that referenced this issue Mar 28, 2021
@rrthomas
feat(jq): support all command-line options (#507)
450c676 
The options are not all listed by --help, so look in the man page to
find a nearly complete list (I hope!). Neither the man page nor --help
mentions --help or --version; I have not looked elsewhere to see if
there might be yet more.

Guard against the possibility of jq being fixed in future by testing to
see if its --help output contains “--help” and using it if so,
otherwise, use the hard-coded list; see
jqlang/jq#2284
@itchyny itchyny added the docs label Jun 3, 2023
@itchyny itchyny added this to the 1.7 release milestone Jun 25, 2023
@itchyny itchyny mentioned this issue Jun 28, 2023
Closed
@itchyny itchyny mentioned this issue Jul 22, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
1.7 release
Development

Successfully merging a pull request may close this issue.

Improve --help to mention all the command options itchyny/jq
2 participants
@rrthomas @itchyny