Fix man page section assignments for end-user interactive clients #2977
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
jimklimov
added
bug
enhancement
packaging
documentation
CI
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 3, 2025
…gest_doc_links_CMD_USR() [networkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 3, 2025
…scmd/upsrw [networkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 4, 2025
…ments [networkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 4, 2025
…gest_doc_links_CMD_USR() [networkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 4, 2025
…scmd/upsrw [networkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
jimklimov
force-pushed
the
issue-2977
branch
2 times, most recently
from
c19e07d to
1c9a5d2
Compare
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 4, 2025
… clients (man1) [networkupstools#2977] * Section 1 (programs): upsc, upscmd, upsrw, NUT-Monitor * Section 8 (daemons): upsmon, upssched Signed-off-by: Jim Klimov <[email protected]>
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 4, 2025
…gest_doc_links_CMD_USR() [networkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 4, 2025
…scmd/upsrw [networkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 4, 2025
…tworkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 4, 2025
… clients (man1) [networkupstools#2977] * Section 1 (programs): upsc, upscmd, upsrw, NUT-Monitor * Section 8 (daemons): upsmon, upssched Signed-off-by: Jim Klimov <[email protected]>
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 4, 2025
…gest_doc_links_CMD_USR() [networkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 4, 2025
…scmd/upsrw [networkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
jimklimov
added a commit
to jimklimov/nut
that referenced
this pull request
Jun 4, 2025
…tworkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
|
Due to the questionable nature of the man page section change, this PR was split: #2978 takes care of general docs improvements (including the fix of man sections from Raised a discussion on mailing list: https://alioth-lists.debian.net/pipermail/nut-upsdev/2025-June/008151.html |
|
❌ Build nut 2.8.3.3258-master failed (commit aa2d795a1c by @jimklimov) |
… clients (man1) [networkupstools#2977] * Section 1 (programs): upsc, upscmd, upsrw, NUT-Monitor * Section 8 (daemons): upsmon, upssched Signed-off-by: Jim Klimov <[email protected]>
…gest_doc_links_CMD_USR() [networkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
…scmd/upsrw [networkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
…tworkupstools#2977] Signed-off-by: Jim Klimov <[email protected]>
|
Rebased over recent state of PR #2978 as it got merged. |
|
❌ Build nut 2.8.3.3264-master failed (commit ca7a491e62 by @jimklimov) |
|
For now suspending this idea, maybe even until after a NUT v2.8.4 release. May lead to path re-assignments for some programs as well. |
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.
There was some mess in existing pages; bolt down the man pave section for these programs:
upsc,upscmd,upsrwandNUT-Monitor. Being (semi-)interactive end-user clients, they belong in section 1 rather than 8 (system daemons)..htmlextension).UPDATE: Due to the questionable nature of the man page section change, this PR was split: #2978 takes care of general docs improvements (including the fix of man sections from
1to8where they got mis-referenced in existing docs vs. existing layout), and this PR was rebased on top of that to propose the re-organization of the layout itself. Also, should this go further, moving tools likenut-scannerandnutconfto section 1? If we do end up breaking everyone's packaging recipes, better limit the pain to one NUT release.Raised a discussion on mailing list: https://alioth-lists.debian.net/pipermail/nut-upsdev/2025-June/008151.html