Man page: fix incorrect name of user conf file in barriers.1 #507
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The leading dot was lost in documentation in previous change while moving file to another directory. The usage of leading dot in non-home folder is not a common practice, but this is the current behavior, and this commit just update man page to match the code. Also the man pages has a not that they are auto-generated by help2man. I used help2man to update them, but it's output has some problems (wrong formatting of copyrights). So in addition to the only important change (naming fix) there is some more changes: * Formatting manually added to the list of config files. * New option --screen-change-script auto-added by help2man * Man files themselves and doc/UpdateManpages.txt now mention that some manual work is needed after help2man
|
The main idea of this patch is to fix wrong config file name in barriers man page - this is really misleading. All other changes are completely optional. So if there are any problems with them, I can recreate a minimal PR adding only '.' without any other changes. |
AdrianKoshka
added
doc
ghost
mentioned this pull request
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The leading dot was lost in documentation in previous change
while moving file to another directory.
The usage of leading dot in non-home folder is not a common practice,
but this is the current behavior,
and this commit just update man page to match the code.
Also the man pages has a not that they are auto-generated by help2man.
I used help2man to update them,
but it's output has some problems (wrong formatting of copyrights).
So in addition to the only important change (naming fix)
there is some more changes:
that some manual work is needed after help2man