-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Update the man page of bat (assets/manual/bat.1.in
)
#2995
Conversation
I believe this to be the case, nothing is hidden |
Thanks! I now checked
They seem to be intentionally hidden from the help text. However, the completion settings seem to generate such "hidden" options.
I also note that the last four items ( |
68b92e2
to
a94df1f
Compare
May I ask what is blocking this PR? Is there anything I can do for this PR? |
@keith-hall Wow, thank you for your quick response! |
The man page of
bat
(assets/manual/bat.1.in
) doesn't seem to be up-to-date compared to the output obtained bybat --help
and the options completed byassets/completion/bat.bash.in
.Originally reported by akinomyoga/ble.sh#458 (comment). A Bash interactive setting
ble.sh
extracts the descriptions of the options generated by programmable completions from the man page, but the discrepancy between the programmable completionassets/completion/bat.bash.in
and the man pageassets/manual/bat.1.in
causes missing descriptions for some options.However, I still see discrepancies between different files:
doc/long-help.txt
andbat --help
doc/short-help.txt
andbat -h
assets/completion/bat.bash.in
assets/completion/bat.fish.in
assets/completion/bat.zsh.in
assets/manual/bat.1.in
Not a single one out of the above list matches another, which means that there are six different sets of options. Also, some options appearing in several files have different descriptions in the above files. Which one would be considered the up-to-date information that reflects the public interface? Or may all of the options defined in
src/bin/bat/clap_app.rs
be used by the users (i.e., there are no hidden options)?Fixes: #2996 ... I initially didn't include the fix for #2996, but I decided to include also the fix for #2996 in this PR cf #2995 (comment).