Package: libselinux1-dev
Version: 3.8.1-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 "grep -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>:58: 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.20-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.45-1
ii libselinux1 3.8.1-1
ii libsepol-dev 3.8.1-1
libselinux1-dev recommends no packages.
libselinux1-dev suggests no packages.
-- no debconf information
Input file is context_new.3
Output from "mandoc -T lint context_new.3": (shortened list)
1 input text line longer than 80 bytes: context_new, context...
1 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-nroff -mandoc -t -ww -z context_new.3": (shortened list)
1 line(s) with a trailing space
Remove trailing space with: sed -e 's/ *$//'
-.-.
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
-.-.
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.
Add "\:" to split the string for the output, "\<newline>" in the source.
Line 1, length 88
.TH "context_new" "3" "20 December 2011" "dwa...@redhat.com" "SELinux API
documentation"
Line 3, length 235
context_new, context_str, context_free, context_type_get, context_type_set,
context_range_get, context_range_set,context_role_get, context_role_set,
context_user_get, context_user_set \- Routines to manipulate SELinux security
contexts
Longest line is number 3 with 235 characters
-.-.
Put a subordinate sentence (after a comma) on a new line.
context_new.3:3:context_new, context_str, context_free, context_type_get,
context_type_set, context_range_get, context_range_set,context_role_get,
context_role_set, context_user_get, context_user_set \- Routines to manipulate
SELinux security contexts
-.-.
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.
context_new.3:1:.TH "context_new" "3" "20 December 2011" "dwa...@redhat.com"
"SELinux API documentation"
context_new.3:2:.SH "NAME"
context_new.3:5:.SH "SYNOPSIS"
context_new.3:30:.SH "DESCRIPTION"
context_new.3:83:.BR selinux "(8)"
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
2:.SH "NAME"
5:.SH "SYNOPSIS"
30:.SH "DESCRIPTION"
71:.SH "RETURN VALUE"
82:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:58: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- context_new.3 2025-04-03 21:50:44.367432454 +0000
+++ context_new.3.new 2025-04-03 21:55:40.451247954 +0000
@@ -1,8 +1,12 @@
-.TH "context_new" "3" "20 December 2011" "dwa...@redhat.com" "SELinux API
documentation"
-.SH "NAME"
-context_new, context_str, context_free, context_type_get, context_type_set,
context_range_get, context_range_set,context_role_get, context_role_set,
context_user_get, context_user_set \- Routines to manipulate SELinux security
contexts
+.TH context_new 3 "20 December 2011" dwa...@redhat.com "SELinux API \
+documentation"
+.SH NAME
+context_new, context_str, context_free, context_type_get,
+context_type_set, context_range_get, context_range_set,context_role_get,
+context_role_set, context_user_get, context_user_set \- Routines to
+manipulate SELinux security contexts
.
-.SH "SYNOPSIS"
+.SH SYNOPSIS
.B #include <selinux/context.h>
.sp
.BI "context_t context_new(const char *" context_str );
@@ -27,7 +31,7 @@ context_new, context_str, context_free,
.sp
.BI "int context_user_set(context_t " con ", const char *" user );
.
-.SH "DESCRIPTION"
+.SH DESCRIPTION
These functions allow an application to manipulate the fields of a
security context string without requiring it to know the format of the
string.
@@ -55,7 +59,7 @@ frees the storage used by a context.
get a pointer to the string value of a context component.
.B Note:
-Values returned by the get functions are only valid until the next call
+Values returned by the get functions are only valid until the next call
to a set function or
.BR context_free ()
for the same
@@ -68,7 +72,7 @@ structure.
.BR \%context_user_set ()
set a context component.
.
-.SH "RETURN VALUE"
+.SH RETURN VALUE
On failure
.BR context_*_set ()
functions return non-zero and 0 on success.
@@ -79,5 +83,5 @@ On failure
.I errno
is set appropriately.
.
-.SH "SEE ALSO"
+.SH SEE ALSO
.BR selinux "(8)"
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>
To find trailing space use
grep -e ' $' -e ' \\f.$' -e ' "$' <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.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size 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 -d -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 -d -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)
-.-
