Your message dated Tue, 15 Apr 2025 18:11:46 +1000 with message-id <[email protected]> and subject line w.1 manpage fixed has caused the Debian Bug report #1077367, regarding w.1: Some remarks and editorial changes for this man page to be marked as done.
This means that you claim that the problem has been dealt with. If this is not the case it is now your responsibility to reopen the Bug report if necessary, and/or fix the problem forthwith. (NB: If you are a system administrator and have no idea what this message is talking about, this may indicate a serious mail system misconfiguration somewhere. Please contact [email protected] immediately.) -- 1077367: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1077367 Debian Bug Tracking System Contact [email protected] with problems
--- Begin Message ---Package: procps Version: 2:4.0.4-5 Severity: minor Tags: patch * What led up to the situation? Checking for defects with [test-]groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page" [test-groff is a script in the repository for "groff"] (local copy and "troff" slightly changed by me). * What was the outcome of this action? troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':562: macro 'B' troff: backtrace: file '<stdin>':79 troff:<stdin>:79: warning: trailing space in the line * What outcome did you expect instead? No output (no warnings). -.- General remarks and further material (declared as a "diff" file) are in the attachments. -- System Information: Debian Release: trixie/sid APT prefers testing APT policy: (500, 'testing') Architecture: amd64 (x86_64) Kernel: Linux 6.9.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 procps depends on: ii init-system-helpers 1.66 ii libc6 2.39-4 ii libncursesw6 6.5-2 ii libproc2-0 2:4.0.4-5 ii libsystemd0 256.4-2 ii libtinfo6 6.5-2 Versions of packages procps recommends: pn linux-sysctl-defaults <none> ii psmisc 23.7-1 procps suggests no packages. -- no debconf informationAny program (person), that produces man pages, should check its content for defects by using groff -mandoc -t -ww -b -z [ -K utf8 | k ] <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 errors: 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 (that is not confined to a markup) in the first column. Line length should thus be reduced. -.- 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 -z" export MAN_KEEP_STDERR=yes (or any non-empty value) -.-. Use the correct macro for the font change of a single argument or split the argument into two. 49:.BR "w \-u". -.-. Use a macro to change to the italic font, instead of \fI, if possible (see man-pages(7)). The macros have the italic corrections, but "\c" removes the "\/" part, which is in the macro. So "\/" must be added between the italic argument and the "\c" string. Or add the italic corrections. 19:[\fIoptions\fR] [\fIuser\fR] -.-. Wrong distance between sentences. 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. 110:Michael K. Johnson -.-. Output from "test-groff -b -mandoc -rF0 -rHY=0 -K utf8 -t -ww -z ": troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':562: macro 'B' troff: backtrace: file '<stdin>':79 troff:<stdin>:79: warning: trailing space in the line--- w.1 2024-07-28 09:11:27.910517447 +0000 +++ w.1.new 2024-07-28 10:09:17.447750148 +0000 @@ -16,7 +16,7 @@ w \- Show who is logged on and what they are doing. .SH SYNOPSIS .B w -[\fIoptions\fR] [\fIuser\fR] +.RI [ options "] [" user ] .SH DESCRIPTION .B w displays information about the users currently on the machine, and their @@ -46,7 +46,7 @@ current process and cpu times. To demon and do a .B w and a -.BR "w \-u". +.BR "w \-u" . .TP \fB\-s\fR, \fB\-\-short\fR Use the short format. Don't print the login time, JCPU or PCPU times. @@ -107,7 +107,7 @@ Larry Greenfield .UE and .UR johnsonm@\:redhat.\:com -Michael K. Johnson +Michael K.\& Johnson .UE .SH "REPORTING BUGS" Please send bug reports to
--- End Message ---
--- Begin Message ---Package: procps Version 2:4.0.4-7 procps 4.0.4-7 has these updates.
--- End Message ---
