[DSE-Dev] Bug#1094888: is_selinux_enabled.3: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Sat Feb 1 00:46:21 GMT 2025
Package: libselinux1-dev
Version: 3.7-3+b1
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?
troff:<stdin>:17: 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.10-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+b1
ii libsepol-dev 3.7-1
libselinux1-dev recommends no packages.
libselinux1-dev suggests no packages.
-- no debconf information
-------------- next part --------------
Input file is is_selinux_enabled.3
Output from "mandoc -T lint is_selinux_enabled.3": (shortened list)
1 input text line longer than 80 bytes: is_selinux_mls_enabl...
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z is_selinux_enabled.3": (shortened list)
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
-.-.
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 "\&".
20:returns 1 if SELinux is capable of running in MLS mode or 0 if it is not. To
-.-.
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 92
.TH "is_selinux_enabled" "3" "7 Mar 2010" "russell at coker.com.au" "SELinux API documentation"
Line 6, length 89
is_selinux_mls_enabled \- check whether SELinux is enabled for (Multi Level Security) MLS
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
is_selinux_enabled.3:6:is_selinux_mls_enabled \- check whether SELinux is enabled for (Multi Level Security) MLS
-.-.
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 "is_selinux_enabled" "3" "7 Mar 2010" "russell at coker.com.au" "SELinux API documentation"
2:.SH "NAME"
5:.SH "NAME"
8:.SH "SYNOPSIS"
15:.SH "DESCRIPTION"
25:.BR selinux "(8)"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
-------------- next part --------------
--- is_selinux_enabled.3 2025-02-01 00:28:58.152205618 +0000
+++ is_selinux_enabled.3.new 2025-02-01 00:37:03.709062343 +0000
@@ -1,25 +1,31 @@
-.TH "is_selinux_enabled" "3" "7 Mar 2010" "russell at coker.com.au" "SELinux API documentation"
-.SH "NAME"
+.TH is_selinux_enabled 3 "7 Mar 2010" russell at coker.com.au \
+"SELinux API documentation"
+.SH NAME
is_selinux_enabled \- check whether SELinux is enabled
.
-.SH "NAME"
-is_selinux_mls_enabled \- check whether SELinux is enabled for (Multi Level Security) MLS
+.SH NAME
+is_selinux_mls_enabled \- check whether SELinux is enabled for
+(Multi Level Security)
+MLS
.
-.SH "SYNOPSIS"
+.SH SYNOPSIS
.B #include <selinux/selinux.h>
.sp
.B int is_selinux_enabled(void);
.sp
.B int is_selinux_mls_enabled(void);
.
-.SH "DESCRIPTION"
+.SH DESCRIPTION
.BR is_selinux_enabled ()
-returns 1 if SELinux is running or 0 if it is not.
+returns 1 if SELinux is running or 0 if it is not.
.BR is_selinux_mls_enabled ()
-returns 1 if SELinux is capable of running in MLS mode or 0 if it is not. To
-determine the policy in use on the system, use
+returns 1
+if SELinux is capable of running in MLS mode
+or 0 if it is not.
+To determine the policy in use on the system,
+use
.BR selinux_getpolicytype (3).
.
.SH "SEE ALSO"
-.BR selinux "(8)"
+.BR selinux (8)
-------------- next part --------------
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)
-.-
More information about the SELinux-devel
mailing list