#1094149 vgdb.1: Some remarks about this man page

Package:
valgrind
Source:
valgrind
Description:
instrumentation framework for building dynamic analysis tools
Submitter:
Bjarni Ingi Gislason
Date:
2025-03-31 00:48:01 UTC
Severity:
normal
Tags:
#1094149#5
Date:
2025-01-25 02:23:12 UTC
From:
To:
   * 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 ' $' <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>:214: warning: [page 2, 8.4i]: cannot break line

Output from "test-nroff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":

troff:<stdin>:204: warning [page 2, line 54]: cannot break line
troff:<stdin>:209: warning [page 2, line 57]: cannot break line
troff:<stdin>:214: warning [page 2, line 60]: cannot break 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.

#1094149#10
Date:
2025-03-31 00:43:45 UTC
From:
To:
Wrong diff file sent in the attachment.
#1094149#15
Date:
2025-03-31 00:37:59 UTC
From:
To:
Additional material.

Input file is vgdb.1

Output from "mandoc -T lint  vgdb.1": (shortened list)

      1 input text line longer than 80 bytes: ("Valgrind to GDB") ...
      1 input text line longer than 80 bytes: As a standalone util...
      1 input text line longer than 80 bytes: Gives the number of ...
      1 input text line longer than 80 bytes: If you specify a lar...
      1 input text line longer than 80 bytes: In combination with ...
      3 input text line longer than 80 bytes: Instructs a standalo...
      1 input text line longer than 80 bytes: Instructs vgdb to se...
      1 input text line longer than 80 bytes: Instructs vgdb to us...
      1 input text line longer than 80 bytes: Makes vgdb start in ...
      1 input text line longer than 80 bytes: Must be given to bot...
      1 input text line longer than 80 bytes: Specifies the PID of...
      1 input text line longer than 80 bytes: The path to valgrind...
      1 input text line longer than 80 bytes: To give more than on...
      1 input text line longer than 80 bytes: argument in the GDB ...
      1 input text line longer than 80 bytes: argument is not give...
      1 input text line longer than 80 bytes: mode, vgdb uses the ...
      1 input text line longer than 80 bytes: to a relay vgdb, you...
      4 skipping paragraph macro: PP after SH

-.-.

Output from "test-nroff -mandoc -t -ww -z vgdb.1": (shortened list)

      3 cannot break line

-.-.

Show if docman-to-man created this.

Who is actually creating this man page?  Debian or upstream?

Is the generating software out of date?



4:.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>

-.-.

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

-.-.

Strings longer than 3/4 of a standard line length (80).

Use "\:" to split the string at the end of an output line, for example a
long URL (web address)

239 \%http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.gdbserver
244 \%http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.vgdb
249 \%http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.valgrind-monitor-commands

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":

troff:<stdin>:249: warning: [page 3, 1.7i]: cannot break line

Output from "test-nroff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":

troff:<stdin>:239: warning [page 3, line 8]: cannot break line
troff:<stdin>:244: warning [page 3, line 11]: cannot break line
troff:<stdin>:249: warning [page 3, line 14]: cannot break line