#1101512 shellcheck.1: Some remarks and a patch with editorial changes for this man page

Package:
shellcheck
Source:
shellcheck
Description:
lint tool for shell scripts
Submitter:
Bjarni Ingi Gislason
Date:
2025-03-28 16:57:02 UTC
Severity:
normal
Tags:
#1101512#5
Date:
2025-03-28 16:54:36 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 "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?


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

an.tmac:<stdin>:17: style: .TH missing third argument; consider document modification date in ISO 8601 format (YYYY-MM-DD)
troff:<stdin>:43: warning: cannot select font 'V'
troff:<stdin>:44: warning: cannot select font 'V'
troff:<stdin>:44: warning: cannot select font 'V'
troff:<stdin>:47: warning: cannot select font 'V'
troff:<stdin>:48: warning: cannot select font 'V'
troff:<stdin>:51: warning: cannot select font 'V'
troff:<stdin>:52: warning: cannot select font 'V'
troff:<stdin>:52: warning: cannot select font 'V'
troff:<stdin>:58: warning: cannot select font 'V'
troff:<stdin>:112: warning: cannot select font 'V'
troff:<stdin>:113: warning: cannot select font 'V'
troff:<stdin>:114: warning: cannot select font 'V'
troff:<stdin>:120: warning: cannot select font 'V'
troff:<stdin>:121: warning: cannot select font 'V'
troff:<stdin>:123: warning: cannot select font 'V'
troff:<stdin>:141: warning: cannot select font 'V'
troff:<stdin>:143: warning: cannot select font 'V'
troff:<stdin>:144: warning: cannot select font 'V'
troff:<stdin>:145: warning: cannot select font 'V'
troff:<stdin>:148: warning: cannot select font 'V'
troff:<stdin>:149: warning: cannot select font 'V'
troff:<stdin>:167: warning: cannot select font 'V'
troff:<stdin>:168: warning: cannot select font 'V'
troff:<stdin>:168: warning: cannot select font 'V'
troff:<stdin>:205: warning: cannot select font 'V'
troff:<stdin>:205: warning: cannot select font 'V'
troff:<stdin>:272: warning: cannot select font 'V'
troff:<stdin>:309: warning: cannot select font 'V'
troff:<stdin>:312: warning: cannot select font 'V'
troff:<stdin>:313: warning: cannot select font 'V'
troff:<stdin>:318: warning: cannot select font 'V'
troff:<stdin>:322: warning: cannot select font 'V'
troff:<stdin>:328: warning: cannot select font 'V'
troff:<stdin>:328: warning: cannot select font 'V'
troff:<stdin>:333: warning: cannot select font 'V'
troff:<stdin>:339: warning: cannot select font 'V'
troff:<stdin>:339: warning: cannot select font 'V'
troff:<stdin>:343: warning: cannot select font 'V'
troff:<stdin>:346: warning: cannot select font 'V'
troff:<stdin>:346: warning: cannot select font 'V'
troff:<stdin>:350: warning: cannot select font 'V'
troff:<stdin>:352: warning: cannot select font 'V'
troff:<stdin>:353: warning: cannot select font 'V'
troff:<stdin>:354: warning: cannot select font 'V'
troff:<stdin>:363: warning: cannot select font 'V'
troff:<stdin>:364: warning: cannot select font 'V'
troff:<stdin>:364: warning: cannot select font 'V'
troff:<stdin>:366: warning: cannot select font 'V'
troff:<stdin>:369: warning: cannot select font 'V'
troff:<stdin>:395: warning: cannot select font 'V'
troff:<stdin>:396: warning: cannot select font 'V'
troff:<stdin>:397: warning: cannot select font 'V'
troff:<stdin>:398: warning: cannot select font 'V'
troff:<stdin>:402: warning: cannot select font 'V'
troff:<stdin>:405: warning: cannot select font 'V'
troff:<stdin>:409: warning: cannot select font 'V'
troff:<stdin>:441: warning: cannot select font 'V'
troff:<stdin>:442: warning: cannot select font 'V'
troff:<stdin>:445: warning: cannot select font 'V'
troff:<stdin>:446: warning: cannot select font 'V'
troff:<stdin>:453: warning: cannot select font 'V'
troff:<stdin>:454: warning: cannot select font 'V'
troff:<stdin>:454: warning: cannot select font 'V'
troff:<stdin>:455: warning: cannot select font 'V'
troff:<stdin>:467: warning: cannot select font 'V'
troff:<stdin>:469: warning: cannot select font 'V'
troff:<stdin>:471: warning: cannot select font 'V'
troff:<stdin>:474: warning: cannot select font 'V'
troff:<stdin>:475: warning: cannot select font 'V'
troff:<stdin>:477: warning: cannot select font 'V'
troff:<stdin>:479: warning: cannot select font 'V'
troff:<stdin>:481: warning: cannot select font 'V'
troff:<stdin>:482: warning: cannot select font 'V'
troff:<stdin>:483: warning: cannot select font 'V'
troff:<stdin>:483: warning: cannot select font 'V'


   * What outcome did you expect instead?

     No output (no warnings).

-.-

  General remarks and further material, if a diff-file exist, are in the
attachments.