libcasper: fix mandoc lint warnings in services man pages#2194
Closed
xiujunma wants to merge 1 commit into
Closed
Conversation
- cap_net.3: drop trailing comma on last .Nm before .Nd - cap_netdb.3: drop trailing comma on last .Nm before .Nd - cap_pwd.3: fix self-xref to cap_endpwent(3); should be endpwent(3) (the page documents cap_endpwent, and the surrounding list mirrors the libc pwent functions it is equivalent to)
|
Thank you for taking the time to contribute to FreeBSD! There is an issue that needs to be resolved:
Note Please review CONTRIBUTING.md, then update and push your branch again. |
Author
|
Superseded by #2195 (rebased with Signed-off-by trailer; original PR head got desynced after force-push). |
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
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.
What
Fix three real
mandoc -T lint -W warningwarnings inlib/libcasper/services/man pages.Changes
cap_net.3— drop trailing comma on the last.Nmbefore.Nd(mdoc convention).cap_netdb.3— same: drop trailing comma on the single.Nmbefore.Nd.cap_pwd.3— change.Xr cap_endpwent 3to.Xr endpwent 3. The page documentscap_endpwent, so.Xr cap_endpwent 3is a self-reference. The surrounding text describes the cap_pwd functions as "respectively equivalent to" a list of libc functions (getpwent,getpwnam,setpwent, …) — the intended trailing entry is thereforeendpwent(3). This is the only content change in the PR.Verification
mandoc -T lint -W warningbefore:mandoc -T lint -W warningafter:The three remaining
unknown library name: Lb libcap_*warnings are intentionally out of scope. The.Lb libcap_*invocations in the pages are correct mdoc; the warnings come from mandoc's bundled library-name database not knowing these names. Fixing that belongs in mandoc upstream, not in these pages.Out of scope
cap_sysctl.3has asections out of conventional order: Sh RETURN VALUESwarning. Real defect; saved for a separate, larger PR because the fix requires moving a whole section.Lb libcap_*warnings noted above.