Package: plocate
Version: 1.1.23-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?
troff:<stdin>:13: 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.12-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 plocate depends on:
ii adduser 3.137
ii libc6 2.40-7
ii libgcc-s1 14.2.0-16
ii libstdc++6 14.2.0-16
ii liburing2 2.9-1
ii libzstd1 1.5.6+dfsg-2
plocate recommends no packages.
Versions of packages plocate suggests:
pn systemd-sysv | nocache <none>
pn systemd-sysv | powermgmt-base <none>
-- no debconf information
Input file is plocate-build.8
Output from "mandoc -T lint plocate-build.8": (shortened list)
1 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-groff -mandoc -t -ww -z plocate-build.8": (shortened list)
1 trailing space in the line
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
-.-.
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 "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
N.B.
The number of lines affected can be too large to be in a patch.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
19:package. Most users would rather want to use plocate's own
24:already exists, it will be overwritten (non-atomically). The file is
36:in the posting lists. This makes the index smaller (because the compression
43:per block. However, making it too large will cause more false positives,
44:reducing overall performance for typical queries. The default value is 32.
55:generated database to \fIFLAG\fR. The default is yes, even for an mlocate
68:Steinar H. Gunderson <steinar+ploc...@gunderson.no>
-.-.
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.
7:.I "[OPTION]..."
8:.I "MLOCATE_DB"
9:.I "PLOCATE_DB"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:13: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- plocate-build.8 2025-02-26 08:49:50.472599381 +0000
+++ plocate-build.8.new 2025-02-26 08:57:19.383224774 +0000
@@ -4,24 +4,26 @@ plocate\-build \- generate index for plo
.SH SYNOPSIS
.B plocate-build
-.I "[OPTION]..."
-.I "MLOCATE_DB"
-.I "PLOCATE_DB"
+.RI [ OPTION "] ..."
+.I MLOCATE_DB
+.I PLOCATE_DB
.SH DESCRIPTION
.B plocate\-build
-creates an index from
+creates an index from
.BR plocate (1)
from an index earlier generated by
.BR updatedb (8)
from the
.BR mlocate (1)
-package. Most users would rather want to use plocate's own
+package.
+Most users would rather want to use plocate's own
.BR updatedb (8),
which is more direct.
If
.I PLOCATE_DB
-already exists, it will be overwritten (non-atomically). The file is
+already exists, it will be overwritten (non-atomically).
+The file is
created such that it is not world-readable, as the final access check
is done by
.BR plocate (1)
@@ -33,15 +35,18 @@ during the search.
Create blocks containing
.I SIZE
filenames each, compress them together, and treat them as the same element
-in the posting lists. This makes the index smaller (because the compression
+in the posting lists.
+This makes the index smaller (because the compression
algorithm gets more context to work with, and because there are fewer elements
in each posting list), but also makes posting lists less precise, moving more
work to weeding out false positives after posting list intersection.
Making this number larger will make linear search (for \fB\-\-regex\fR,
or very short patterns) faster, with diminishing returns around 256 filenames
-per block. However, making it too large will cause more false positives,
-reducing overall performance for typical queries. The default value is 32.
+per block.
+However, making it too large will cause more false positives,
+reducing overall performance for typical queries.
+The default value is 32.
Setting it to 1 makes one (compressed) block per filename.
.TP
@@ -52,7 +57,8 @@ instead of an mlocate database.
.TP
\fB\-l\fR, \fB\-\-require\-visibility\fR \fIFLAG\fR
Set the \*(lqrequire file visibility before reporting it\*(rq flag in the
-generated database to \fIFLAG\fR. The default is yes, even for an mlocate
+generated database to \fIFLAG\fR.
+The default is yes, even for an mlocate
database with the flag originally set to no (although the latter may
change in the future).
@@ -65,7 +71,7 @@ Print out usage information, then exit s
Print out version information, then exit successfully.
.SH AUTHOR
-Steinar H. Gunderson <steinar+ploc...@gunderson.no>
+Steinar H.\& Gunderson <steinar+ploc...@gunderson.no>
.SH SEE ALSO
\fBplocate\fP(1),
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.
"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)
-.-
