Package: libselinux1-dev
Version: 3.7-3.1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man
page"
[Use "groff -e ' $' -e '\\~$' <file>" to find obvious trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
an.tmac:<stdin>:12: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:14: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:30: warning: trailing space in the line
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.11-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages libselinux1-dev depends on:
ii libpcre2-dev 10.44-5
ii libselinux1 3.7-3.1
ii libsepol-dev 3.7-1
libselinux1-dev recommends no packages.
libselinux1-dev suggests no packages.
-- no debconf information
Input file is matchpathcon_checkmatches.3
Output from "mandoc -T lint matchpathcon_checkmatches.3": (shortened list)
1 input text line longer than 80 bytes: matchpathcon_checkma...
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z matchpathcon_checkmatches.3":
(shortened list)
2 Use macro '.B' for one argument or split argument.
2 .BI is for at least 2 arguments, got 1
1 trailing space in the line
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
1
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
12:.BI "void matchpathcon_filespec_destroy(void);"
14:.BI "void matchpathcon_filespec_eval(void);"
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
29:with the same inode (e.g. due to multiple hard links). If so, then
36:destroys any inode associations that have been added, e.g. to restart
-.-.
Wrong distance between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
3:matchpathcon_checkmatches, matchpathcon_filespec_add,
matchpathcon_filespec_destroy, matchpathcon_filespec_eval \- check and report
whether any specification index has no matches with any inode. Maintenance and
statistics on inode associations
29:with the same inode (e.g. due to multiple hard links). If so, then
32:context configuration. Returns the specification index used or \-1 on
36:destroys any inode associations that have been added, e.g. to restart
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 1, length 115
.TH "matchpathcon_checkmatches" "3" "21 November 2009"
"stephen.smalley.w...@gmail.com" "SELinux API documentation"
Line 3, length 243
matchpathcon_checkmatches, matchpathcon_filespec_add,
matchpathcon_filespec_destroy, matchpathcon_filespec_eval \- check and report
whether any specification index has no matches with any inode. Maintenance and
statistics on inode associations
Line 10, length 90
.BI "int matchpathcon_filespec_add(ino_t " ino ", int " specind ", const char
*" file ");"
Line 48, length 123
.BR selinux "(8), " matchpathcon "(3), " matchpathcon_index "(3), " freecon
"(3), " setfilecon "(3), " setfscreatecon "(3)"
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
matchpathcon_checkmatches.3:29:with the same inode (e.g. due to multiple hard
links). If so, then
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
1:.TH "matchpathcon_checkmatches" "3" "21 November 2009"
"stephen.smalley.w...@gmail.com" "SELinux API documentation"
2:.SH "NAME"
5:.SH "SYNOPSIS"
8:.BI "void matchpathcon_checkmatches(char *" str ");"
10:.BI "int matchpathcon_filespec_add(ino_t " ino ", int " specind ", const
char *" file ");"
16:.SH "DESCRIPTION"
48:.BR selinux "(8), " matchpathcon "(3), " matchpathcon_index "(3), " freecon
"(3), " setfilecon "(3), " setfscreatecon "(3)"
-.-.
Use ".na" (no adjustment) instead of ".ad l" and then ".ad" to begin the
same adjustment again as before
46:.ad l
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:12: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:14: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:30: warning: trailing space in the line
--- matchpathcon_checkmatches.3 2025-02-03 01:44:40.680682298 +0000
+++ matchpathcon_checkmatches.3.new 2025-02-03 01:45:53.714576597 +0000
@@ -1,19 +1,24 @@
-.TH "matchpathcon_checkmatches" "3" "21 November 2009"
"stephen.smalley.w...@gmail.com" "SELinux API documentation"
-.SH "NAME"
-matchpathcon_checkmatches, matchpathcon_filespec_add,
matchpathcon_filespec_destroy, matchpathcon_filespec_eval \- check and report
whether any specification index has no matches with any inode. Maintenance and
statistics on inode associations
+.TH matchpathcon_checkmatches 3 "21 November 2009" \
+stephen.smalley.w...@gmail.com "SELinux API documentation"
+.SH NAME
+matchpathcon_checkmatches, matchpathcon_filespec_add,
+matchpathcon_filespec_destroy, matchpathcon_filespec_eval \- check and report
+whether any specification index has no matches with any inode.
+Maintenance and statistics on inode associations
.
-.SH "SYNOPSIS"
+.SH SYNOPSIS
.B #include <selinux/selinux.h>
.sp
-.BI "void matchpathcon_checkmatches(char *" str ");"
+.BI "void matchpathcon_checkmatches(char *" str );
.sp
-.BI "int matchpathcon_filespec_add(ino_t " ino ", int " specind ", const char
*" file ");"
+.BI "int matchpathcon_filespec_add(ino_t " ino ", int " specind \
+", const char *" file );
.sp
-.BI "void matchpathcon_filespec_destroy(void);"
+.B void matchpathcon_filespec_destroy(void);
.sp
-.BI "void matchpathcon_filespec_eval(void);"
+.B void matchpathcon_filespec_eval(void);
.
-.SH "DESCRIPTION"
+.SH DESCRIPTION
.BR matchpathcon_checkmatches ()
checks whether any specification has no matches and reports them.
The
@@ -26,15 +31,17 @@ maintains an association between an inod
and a specification index
.IR specind ,
and checks whether a conflicting specification is already associated
-with the same inode (e.g. due to multiple hard links). If so, then
-it uses the latter of the two specifications based on their order in the
+with the same inode
+(e.g., due to multiple hard links).
+If so,
+then it uses the latter of the two specifications based on their order in the
.I file
-context configuration. Returns the specification index used or \-1 on
-error.
+context configuration.
+Returns the specification index used or \-1 on error.
.sp
.BR matchpathcon_filespec_destroy ()
-destroys any inode associations that have been added, e.g. to restart
-for a new filesystem.
+destroys any inode associations that have been added,
+e.g., to restart for a new filesystem.
.sp
.BR matchpathcon_filespec_eval ()
displays statistics on the hash table usage for the inode associations.
@@ -43,6 +50,7 @@ displays statistics on the hash table us
Returns zero on success or \-1 otherwise.
.
.SH "SEE ALSO"
-.ad l
+.na
.nh
-.BR selinux "(8), " matchpathcon "(3), " matchpathcon_index "(3), " freecon
"(3), " setfilecon "(3), " setfscreatecon "(3)"
+.BR selinux "(8), " matchpathcon "(3), " matchpathcon_index "(3), " freecon \
+"(3), " setfilecon "(3), " setfscreatecon (3)
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
Not beginning each input sentence on a new line.
Line length should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
See man-pages(7), item "semantic newline".
-.-
The difference between the formatted output of the original and patched file
can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
\"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - \"
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output from 'diff -u ...' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option \"-warnings=w\"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT=\"-ww -b -z\"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-
