Package: adjtimex
Version: 1.29-11.1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
[test-][g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
["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: backtrace: file '<stdin>':16
troff:<stdin>:16: warning: trailing space in the line
troff: backtrace: file '<stdin>':23
troff:<stdin>:23: warning: trailing space in the line
troff: backtrace: file '<stdin>':31
troff:<stdin>:31: warning: trailing space in the line
troff: backtrace: file '<stdin>':137
troff:<stdin>:137: warning: trailing space in the line
troff: backtrace: file '<stdin>':144
troff:<stdin>:144: warning: trailing space in the line
troff: backtrace: file '<stdin>':199
troff:<stdin>:199: warning: trailing space in the line
troff: backtrace: file '<stdin>':200
troff:<stdin>:200: warning: trailing space in the line
troff: backtrace: file '<stdin>':201
troff:<stdin>:201: warning: trailing space in the line
troff: backtrace: file '<stdin>':220
troff:<stdin>:220: warning: trailing space in the line
troff: backtrace: file '<stdin>':221
troff:<stdin>:221: warning: trailing space in the line
troff: backtrace: file '<stdin>':222
troff:<stdin>:222: warning: trailing space in the line
troff: backtrace: file '<stdin>':223
troff:<stdin>:223: warning: trailing space in the line
troff: backtrace: file '<stdin>':224
troff:<stdin>:224: warning: trailing space in the line
troff: backtrace: file '<stdin>':225
troff:<stdin>:225: warning: trailing space in the line
troff: backtrace: file '<stdin>':226
troff:<stdin>:226: warning: trailing space in the line
troff: backtrace: file '<stdin>':227
troff:<stdin>:227: warning: trailing space in the line
troff: backtrace: file '<stdin>':228
troff:<stdin>:228: warning: trailing space in the line
troff: backtrace: file '<stdin>':231
troff:<stdin>:231: warning: trailing space in the line
troff: backtrace: file '<stdin>':233
troff:<stdin>:233: warning: trailing space in the line
troff: backtrace: file '<stdin>':235
troff:<stdin>:235: warning: trailing space in the line
troff: backtrace: file '<stdin>':238
troff:<stdin>:238: warning: trailing space in the line
troff: backtrace: file '<stdin>':252
troff:<stdin>:252: warning: trailing space in the line
troff: backtrace: file '<stdin>':351
troff:<stdin>:351: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':649: macro 'BR'
troff: backtrace: file '<stdin>':356
troff:<stdin>:356: 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.11.2-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 adjtimex depends on:
ii debconf [debconf-2.0] 1.5.87
ii libc6 2.40-3
adjtimex recommends no packages.
Versions of packages adjtimex suggests:
pn ntpdate <none>
-- Configuration Files:
/etc/init.d/adjtimex changed [not included]
-- debconf information excluded
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
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
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.
Lines should thus be shorter.
See man-pages(7), item 'semantic newline'.
-.-
The difference between the formatted outputs 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 of '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)
-.-.
Output from "mandoc -T lint adjtimex.8": (possibly shortened list)
mandoc: adjtimex.8:16:65: STYLE: whitespace at end of input line
mandoc: adjtimex.8:23:44: STYLE: whitespace at end of input line
mandoc: adjtimex.8:31:63: STYLE: whitespace at end of input line
mandoc: adjtimex.8:196:55: STYLE: whitespace at end of input line
mandoc: adjtimex.8:199:57: STYLE: whitespace at end of input line
mandoc: adjtimex.8:200:55: STYLE: whitespace at end of input line
mandoc: adjtimex.8:201:74: STYLE: whitespace at end of input line
mandoc: adjtimex.8:202:53: STYLE: whitespace at end of input line
mandoc: adjtimex.8:220:10: STYLE: whitespace at end of input line
mandoc: adjtimex.8:221:10: STYLE: whitespace at end of input line
mandoc: adjtimex.8:222:10: STYLE: whitespace at end of input line
mandoc: adjtimex.8:223:10: STYLE: whitespace at end of input line
mandoc: adjtimex.8:224:10: STYLE: whitespace at end of input line
mandoc: adjtimex.8:225:10: STYLE: whitespace at end of input line
mandoc: adjtimex.8:226:10: STYLE: whitespace at end of input line
mandoc: adjtimex.8:227:10: STYLE: whitespace at end of input line
mandoc: adjtimex.8:228:10: STYLE: whitespace at end of input line
mandoc: adjtimex.8:231:26: STYLE: whitespace at end of input line
mandoc: adjtimex.8:233:28: STYLE: whitespace at end of input line
mandoc: adjtimex.8:235:57: STYLE: whitespace at end of input line
mandoc: adjtimex.8:238:43: STYLE: whitespace at end of input line
mandoc: adjtimex.8:252:13: STYLE: whitespace at end of input line
mandoc: adjtimex.8:351:42: STYLE: whitespace at end of input line
mandoc: adjtimex.8:356:61: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
16:This program gives you raw access to the kernel time variables.
23:at startup to initialize the system clock.
31:automatically update the hardware clock every eleven minutes.
137: 0 clock is synchronized (so the kernel should
144: 5 clock not externally synchronized (so the
199:The kernel code adjusts the time gradually by \fIadj\fP,
200:notes how long it has been since the last time offset,
201:and then adjusts the frequency offset to correct for the apparent drift.
202:.\"The short range of this parameter makes it almost
220:\fB\-t\fP
221:\fB\-T\fP
222:\fB\-t\fP
223:\fB\-e\fP
224:\fB\-m\fP
225:\fB\-f\fP
226:\fB\-s\fP
227:\fB\-o\fP
228:\fB\-c\fP
231:Set maximum error (usec).
233:Set estimated error (usec).
235:They are merely made available to user processes via the
238:Set phase locked loop (PLL) time constant.
252:in accuracy.
351:Steven S.\& Dick <ssd at nevets.oau.org>,
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
" \(em " creates a too big gap in the text (in "troff").
An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-" (end of options) then use "\-\-".
adjtimex.8:184: \fB\-\-tick 9995 \--frequency 32768000\fP
adjtimex.8:185: \fB\-\-tick 10000 \--frequency 0\fP
adjtimex.8:186: \fB\-\-tick 10001 \--frequency \-6553600\fP
adjtimex.8:187: \fB\-\-tick 10002 \--frequency \-13107200\fP
adjtimex.8:188: \fB\-\-tick 10005 \--frequency \-32768000\fP
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
20:Your computer has two clocks - the "hardware clock" that runs all the
114:.RI -r[ file ]
-.-.
Use \(en (en-dash) for a dash between space characters,
not a minus (\-) or a hyphen (-), except in the NAME section.
adjtimex.8:20:Your computer has two clocks - the "hardware clock" that runs all
the
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':16
troff:<stdin>:16: warning: trailing space in the line
troff: backtrace: file '<stdin>':23
troff:<stdin>:23: warning: trailing space in the line
troff: backtrace: file '<stdin>':31
troff:<stdin>:31: warning: trailing space in the line
troff: backtrace: file '<stdin>':137
troff:<stdin>:137: warning: trailing space in the line
troff: backtrace: file '<stdin>':144
troff:<stdin>:144: warning: trailing space in the line
troff: backtrace: file '<stdin>':199
troff:<stdin>:199: warning: trailing space in the line
troff: backtrace: file '<stdin>':200
troff:<stdin>:200: warning: trailing space in the line
troff: backtrace: file '<stdin>':201
troff:<stdin>:201: warning: trailing space in the line
troff: backtrace: file '<stdin>':220
troff:<stdin>:220: warning: trailing space in the line
troff: backtrace: file '<stdin>':221
troff:<stdin>:221: warning: trailing space in the line
troff: backtrace: file '<stdin>':222
troff:<stdin>:222: warning: trailing space in the line
troff: backtrace: file '<stdin>':223
troff:<stdin>:223: warning: trailing space in the line
troff: backtrace: file '<stdin>':224
troff:<stdin>:224: warning: trailing space in the line
troff: backtrace: file '<stdin>':225
troff:<stdin>:225: warning: trailing space in the line
troff: backtrace: file '<stdin>':226
troff:<stdin>:226: warning: trailing space in the line
troff: backtrace: file '<stdin>':227
troff:<stdin>:227: warning: trailing space in the line
troff: backtrace: file '<stdin>':228
troff:<stdin>:228: warning: trailing space in the line
troff: backtrace: file '<stdin>':231
troff:<stdin>:231: warning: trailing space in the line
troff: backtrace: file '<stdin>':233
troff:<stdin>:233: warning: trailing space in the line
troff: backtrace: file '<stdin>':235
troff:<stdin>:235: warning: trailing space in the line
troff: backtrace: file '<stdin>':238
troff:<stdin>:238: warning: trailing space in the line
troff: backtrace: file '<stdin>':252
troff:<stdin>:252: warning: trailing space in the line
troff: backtrace: file '<stdin>':351
troff:<stdin>:351: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':649: macro 'BR'
troff: backtrace: file '<stdin>':356
troff:<stdin>:356: warning: trailing space in the line
--- adjtimex.8 2024-10-21 17:47:55.186755923 +0000
+++ adjtimex.8.new 2024-10-21 18:03:46.637775623 +0000
@@ -13,14 +13,14 @@ adjtimex \- display or set the kernel ti
.\"}}}
.\"{{{ Config
.SH DESCRIPTION
-This program gives you raw access to the kernel time variables.
+This program gives you raw access to the kernel time variables.
Anyone may print out the time variables, but only the superuser
may change them.
.PP
-Your computer has two clocks - the "hardware clock" that runs all the
+Your computer has two clocks \(en the "hardware clock" that runs all the
time, and the system clock that runs only while the computer is on.
Normally, "hwclock \-\-hctosys" should be run
-at startup to initialize the system clock.
+at startup to initialize the system clock.
The system clock has much better precision (approximately 1 usec), but
the hardware clock probably has better long-term stability. There are
three basic strategies for managing these clocks.
@@ -28,7 +28,7 @@ three basic strategies for managing thes
For a machine connected to the Internet, or equipped with a precision
oscillator or radio clock, the best way is to regulate the system clock
with \fBntpd\fP(8). The kernel will
-automatically update the hardware clock every eleven minutes.
+automatically update the hardware clock every eleven minutes.
.PP
In addition, \fBhwclock\fP(8) can be used to approximately correct for a
constant drift in the hardware clock. In this case, "hwclock
@@ -111,7 +111,7 @@ follow.
.RI \-\-host " timeserver"
\-w
\-\-watch
-.RI -r[ file ]
+.RI \-r[ file ]
\-\-review[=\,\fIfile\/\fP]
.RI \-\-review[= file ]
\-u
@@ -134,14 +134,14 @@ is "raw", and may be off by up to one ti
gives the value of the \fBtime_status\fP variable in the kernel. For
Linux 1.0 and 1.2 kernels, the value is as follows:
.nf
- 0 clock is synchronized (so the kernel should
+ 0 clock is synchronized (so the kernel should
periodically set the CMOS clock to match the
system clock)
1 inserting a leap second at midnight
2 deleting a leap second at midnight
3 leap second in progress
4 leap second has occurred
- 5 clock not externally synchronized (so the
+ 5 clock not externally synchronized (so the
kernel should leave the CMOS clock alone)
.fi
For Linux kernels 2.0 through 2.6, the value is a sum of these:
@@ -181,11 +181,11 @@ the \fB\-\-tick\fP switch. When USER_HZ
that \fInewfreq\fP = 65536 speeds up the system clock by about 1 ppm,
or 0.0864 sec/day. Thus, all of these are about the same:
.nf
- \fB\-\-tick 9995 \--frequency 32768000\fP
- \fB\-\-tick 10000 \--frequency 0\fP
- \fB\-\-tick 10001 \--frequency \-6553600\fP
- \fB\-\-tick 10002 \--frequency \-13107200\fP
- \fB\-\-tick 10005 \--frequency \-32768000\fP
+ \fB\-\-tick 9995 \-\-frequency 32768000\fP
+ \fB\-\-tick 10000 \-\-frequency 0\fP
+ \fB\-\-tick 10001 \-\-frequency \-6553600\fP
+ \fB\-\-tick 10002 \-\-frequency \-13107200\fP
+ \fB\-\-tick 10005 \-\-frequency \-32768000\fP
.fi
To see the acceptable range for \fInewfreq\fP, use \-\-print and look at
"tolerance", or try an invalid value (e.g., \-\-tick 0).
@@ -193,13 +193,13 @@ To see the acceptable range for \fInewfr
Slew the system clock by \fIadj\fP usec or nsec
(using whichever unit the clock is presently denominated in).
(Its rate is changed temporarily by about 1 part in 2000.)
-.IP "\fB\-o\fP \fIadj\fP, \fB\-\-offset\fP \fIadj\fP"
+.IP "\fB\-o\fP \fIadj\fP, \fB\-\-offset\fP \fIadj\fP"
Add a time offset of \fIadj\fP usec or nsec
(using whichever unit the clock is presently denominated in).
-The kernel code adjusts the time gradually by \fIadj\fP,
-notes how long it has been since the last time offset,
-and then adjusts the frequency offset to correct for the apparent drift.
-.\"The short range of this parameter makes it almost
+The kernel code adjusts the time gradually by \fIadj\fP,
+notes how long it has been since the last time offset,
+and then adjusts the frequency offset to correct for the apparent drift.
+.\"The short range of this parameter makes it almost
.\"totally useless except for use with ntpd:
\fIadj\fP must be in the range \-512000 to 512000.
.IP "\fB\-S\fP \fIstatus\fP, \fB\-\-status\fP \fIstatus\fP"
@@ -217,25 +217,25 @@ because that has the side effect of rese
We try not to actually change the clock setting. Kernel versions
2.0.40 and later apparently don't need this. If your kernel does
require it, use this option with:
-\fB\-t\fP
-\fB\-T\fP
-\fB\-t\fP
-\fB\-e\fP
-\fB\-m\fP
-\fB\-f\fP
-\fB\-s\fP
-\fB\-o\fP
-\fB\-c\fP
+\fB\-t\fP
+\fB\-T\fP
+\fB\-t\fP
+\fB\-e\fP
+\fB\-m\fP
+\fB\-f\fP
+\fB\-s\fP
+\fB\-o\fP
+\fB\-c\fP
\fB\-r\fP.
.IP "\fB\-m\fP \fIval\fP, \fB\-\-maxerror\fP \fIval\fP"
-Set maximum error (usec).
+Set maximum error (usec).
.IP "\fB\-e\fP \fIval\fP, \fB\-\-esterror\fP \fIval\fP"
-Set estimated error (usec).
+Set estimated error (usec).
The maximum and estimated error are not used by the kernel.
-They are merely made available to user processes via the
+They are merely made available to user processes via the
\fBadjtimex\fP(2) system call.
.IP "\fB\-T\fP \fIval\fP, \fB\-\-timeconstant\fP \fIval\fP"
-Set phase locked loop (PLL) time constant.
+Set phase locked loop (PLL) time constant.
\fIval\fP determines the bandwidth or "stiffness"
of the PLL. The effective PLL time constant will be a multiple of
.RI (2^ val ).
@@ -249,7 +249,7 @@ update interval can be as large as 1024
Values of \fIval\fP between zero and 2 give quick convergence; values
between 2 and 6 can be used to reduce network load, but at a modest cost
-in accuracy.
+in accuracy.
.IP "\fB\-c\fP[\fIcount\fP], \fB\-\-compare\fP[\fB=\fP\fIcount\fP]"
Periodically compare the system clock with the CMOS clock. After the
first two calls, print values for tick and frequency offset that would
@@ -348,12 +348,12 @@ see \fBhwclock\fP(8).
.\"}}}
.\"{{{ Author
.SH AUTHORS
-Steven S.\& Dick <ssd at nevets.oau.org>,
+Steven S.\& Dick <ssd at nevets.oau.org>,
Jim Van Zandt <jrv at comcast.net>.
.\"}}}
.\"{{{ See also
.SH "SEE ALSO"
-.BR date "(1L), " gettimeofday "(2), " settimeofday "(2),"
+.BR date "(1L), " gettimeofday "(2), " settimeofday "(2),"
.BR hwclock "(8), " ntpdate "(8), " ntpd "(8)."
.br
Files in the directory
