Updates to manual page and usage message #54
Conversation
This file contains hidden or 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
added 9 commits
July 31, 2018 09:22
Sort option letters by alphabet (numbers first, upper case before lower case) in manual page.
src/sbd-common.c: Sort options alphabetically in usage(). src/sbd-inquisitor.c: Sort options alphabetically for getopt() and switch cases in main().
src/sbd-common.c: Add missing options "-c" and "-D" to usage().
man/sbd.8.pod: Add options -c and -D to manual page for completeness.
man/sbd.8.pod: Rename SUMMARY to DESCRIPTION. Add section OPTIONS. Improve description of options, adding the default value for each. Fix a few typeset conventions.
man/sbd.8.pod: Add subsection "Commands" in "DESCRIPTION", moving all commands down one level. Move "Pacemaker CIB integration" and subsections down one level. Move "Management tasks" and subsections down one level.
man/sbd.8.pod: Fix "1 unescaped <> in paragraph at line 7 in file man/sbd.8.pod" in SYNOPSIS.
man/sbd.8.pod: "SBD" is used in upper and lower cases, sometimes meaning the command, sometimes the concept. Replace most occurencies to be typeset bold (not mono-spaced). Not done for composites like "SBD device".
man/sbd.8.pod: Change each command section so start with the typical command syntax. Try to improve language of remaining sections. Change most "crashdumps" to "crash-dumps". Add sections "SIGNALS" "EXIT STATUS", "ENVIRONMENT" and "FILES", most being quite incomplete. Add several "=for comment" sections where the documentation could and should be improved.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
While configuring SBD, I found out that the manual page is not very complete, and some option syntax is just bad. So I first started to hack the options syntax, but then suspended that, and started to document the program as it is now instead.
This pull request adds massive changes to the manual page, as well as a few changes to the usage() message in C (mostly sorting options by alphabet).