bugGNU roff - Bugs: bug #59415, tmac/groff_mdoc.7.man: Warnings...

 
 

bug #59415: tmac/groff_mdoc.7.man: Warnings from "mandoc -T lint"

Submitter:  Bjarni Ingi Gislason <bjarniig>
Submitted:  Wed 04 Nov 2020 11:40:40 PM UTC
   
 
Category:  Macro package mdoc Severity:  1 - Wish
Item Group:  Documentation Status:  Invalid
Privacy:  Public Assigned to:  schwarze
Open/Closed:  Closed Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Thu 05 Nov 2020 02:14:15 PM UTC, comment #1: 

It is blatantly obvious that groff does not follow the recommendations of the mandoc project for writing manual pages.  There is a huge number of ways in which groff manual pages are systematically and deliberately written in a way that is clearly discouraged by the mandoc project.

Some of the suggestions of the mandoc project have been discussed and rejected.  Some have not been discussed.  Many are of minor importance (in particular of less importance than those explicitly rejected).  While mandoc -T lint can be used to detect syntactic and stylistic oversights in groff documentation, that is tedious work because the main job is filtering out the huge amount of messages that the groff project does not want to do anything about.

Dumping mostly useless output that anybody interested can trivially generate themselves is an unwelcome distraction.

Ingo Schwarze <schwarze>
Group Member
Wed 04 Nov 2020 11:40:40 PM UTC, original submission:  

Subject: tmac/groff_mdoc.7.man: Warnings from "mandoc -T lint"

  mandoc version 1.14.5 shows:

mandoc: groff_mdoc.7.man:735:5: WARNING: undefined string, using "": doc-operating-system
mandoc: groff_mdoc.7.man:735:2: WARNING: skipping empty macro: Tn
mandoc: groff_mdoc.7.man:740:35: WARNING: undefined string, using "": doc-volume-ds-1
mandoc: groff_mdoc.7.man:740:3: WARNING: undefined string, using "": doc-volume-operating-system
mandoc: groff_mdoc.7.man:741:35: WARNING: undefined string, using "": doc-volume-ds-2
mandoc: groff_mdoc.7.man:742:35: WARNING: undefined string, using "": doc-volume-ds-3
mandoc: groff_mdoc.7.man:743:35: WARNING: undefined string, using "": doc-volume-ds-4
mandoc: groff_mdoc.7.man:744:35: WARNING: undefined string, using "": doc-volume-ds-5
mandoc: groff_mdoc.7.man:745:35: WARNING: undefined string, using "": doc-volume-ds-6
mandoc: groff_mdoc.7.man:746:35: WARNING: undefined string, using "": doc-volume-ds-7
mandoc: groff_mdoc.7.man:747:35: WARNING: undefined string, using "": doc-volume-ds-8
mandoc: groff_mdoc.7.man:748:35: WARNING: undefined string, using "": doc-volume-ds-9
mandoc: groff_mdoc.7.man:757:5: WARNING: undefined string, using "": doc-volume-ds-USD
mandoc: groff_mdoc.7.man:758:5: WARNING: undefined string, using "": doc-volume-ds-PS1
mandoc: groff_mdoc.7.man:759:5: WARNING: undefined string, using "": doc-volume-ds-AMD
mandoc: groff_mdoc.7.man:760:5: WARNING: undefined string, using "": doc-volume-ds-SMM
mandoc: groff_mdoc.7.man:761:5: WARNING: undefined string, using "": doc-volume-ds-URM
mandoc: groff_mdoc.7.man:762:5: WARNING: undefined string, using "": doc-volume-ds-PRM
mandoc: groff_mdoc.7.man:763:5: WARNING: undefined string, using "": doc-volume-ds-KM
mandoc: groff_mdoc.7.man:764:5: WARNING: undefined string, using "": doc-volume-ds-IND
mandoc: groff_mdoc.7.man:765:7: WARNING: undefined string, using "": doc-volume-ds-LOCAL
mandoc: groff_mdoc.7.man:766:5: WARNING: undefined string, using "": doc-volume-ds-CON
mandoc: groff_mdoc.7.man:815:5: STYLE: whitespace at end of input line
mandoc: groff_mdoc.7.man:818:5: STYLE: whitespace at end of input line
mandoc: groff_mdoc.7.man:824:37: WARNING: undefined string, using "": doc-volume-as-i386
mandoc: groff_mdoc.7.man:824:7: STYLE: whitespace at end of input line
mandoc: groff_mdoc.7.man:1652:22: WARNING: undefined string, using "": doc-section
mandoc: groff_mdoc.7.man:2591:10: ERROR: skipping column outside column list: Ta
mandoc: groff_mdoc.7.man:55:2: WARNING: first section is not "NAME": Sh Name
mandoc: groff_mdoc.7.man:58:2: WARNING: description line outside NAME section: Nd
mandoc: groff_mdoc.7.man:61:2: WARNING: first section is not "NAME": Sh Synopsis
mandoc: groff_mdoc.7.man:66:2: WARNING: first section is not "NAME": Sh Description
mandoc: groff_mdoc.7.man:77:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:115:2: WARNING: first section is not "NAME": Sh Getting started
mandoc: groff_mdoc.7.man:122:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:133:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:136:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:139:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:142:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:150:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:182:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:187:9: STYLE: consider using OS macro: Nx
mandoc: groff_mdoc.7.man:188:9: STYLE: consider using OS macro: Fx
mandoc: groff_mdoc.7.man:189:9: STYLE: consider using OS macro: Dx
mandoc: groff_mdoc.7.man:190:9: STYLE: consider using OS macro: Ox
mandoc: groff_mdoc.7.man:207:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:219:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:222:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:225:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:228:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:231:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:234:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:237:4: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:245:2: WARNING: first section is not "NAME": Sh troff idiosyncrasies
mandoc: groff_mdoc.7.man:251:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:264:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:275:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:290:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:382:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:398:2: WARNING: missing section argument: Xr Troff
mandoc: groff_mdoc.7.man:406:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:432:2: WARNING: skipping paragraph macro: Pp at the end of Ss
mandoc: groff_mdoc.7.man:440:2: WARNING: missing section argument: Xr Troff
mandoc: groff_mdoc.7.man:558:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:563:2: WARNING: first section is not "NAME": Sh A manual page template
mandoc: groff_mdoc.7.man:636:2: WARNING: first section is not "NAME": Sh Conventions
mandoc: groff_mdoc.7.man:703:2: WARNING: first section is not "NAME": Sh Title macros
mandoc: groff_mdoc.7.man:721:5: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:852:5: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:858:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:860:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:883:5: STYLE: consider using OS macro: Nx
mandoc: groff_mdoc.7.man:891:5: STYLE: consider using OS macro: Fx
mandoc: groff_mdoc.7.man:898:5: STYLE: consider using OS macro: Ox
mandoc: groff_mdoc.7.man:903:5: STYLE: consider using OS macro: Dx
mandoc: groff_mdoc.7.man:927:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:929:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:977:18: STYLE: no blank before trailing delimiter: Li .Dd $Mdocdate:
mandoc: groff_mdoc.7.man:993:2: WARNING: first section is not "NAME": Sh Introduction of manual and general text domains
mandoc: groff_mdoc.7.man:995:29: STYLE: trailing delimiter: Ss ... ...
mandoc: groff_mdoc.7.man:1164:18: STYLE: no blank before trailing delimiter: Ar ... ptr),
mandoc: groff_mdoc.7.man:1191:2: WARNING: missing section argument: Xr Troff
mandoc: groff_mdoc.7.man:1201:2: WARNING: missing section argument: Xr troff
mandoc: groff_mdoc.7.man:1210:2: WARNING: first section is not "NAME": Sh Manual domain
mandoc: groff_mdoc.7.man:1221:18: STYLE: no blank before trailing delimiter: Li .Ad addr1 .
mandoc: groff_mdoc.7.man:1225:25: STYLE: no blank before trailing delimiter: Li .Ad f1 , f2 , f3 :
mandoc: groff_mdoc.7.man:1227:21: STYLE: no blank before trailing delimiter: Li .Ad addr ) ) ,
mandoc: groff_mdoc.7.man:1246:33: STYLE: no blank before trailing delimiter: Li .An \[dq]Joe Author\[dq] ,
mandoc: groff_mdoc.7.man:1250:37: STYLE: no blank before trailing delimiter: Li .An \[dq]Joe Author\[dq] ) ) ,
mandoc: groff_mdoc.7.man:1242:2: WARNING: skipping paragraph macro: Pp before Bl
mandoc: groff_mdoc.7.man:1293:18: STYLE: no blank before trailing delimiter: Li .Ar file1 .
mandoc: groff_mdoc.7.man:1297:21: STYLE: no blank before trailing delimiter: Li .Ar f1 f2 f3 :
mandoc: groff_mdoc.7.man:1299:21: STYLE: no blank before trailing delimiter: Li .Ar file ) ) ,
mandoc: groff_mdoc.7.man:1315:2: WARNING: skipping paragraph macro: Pp before Bl
mandoc: groff_mdoc.7.man:1357:22: STYLE: no blank before trailing delimiter: Li .Dv TIOCGPGRP )
mandoc: groff_mdoc.7.man:1381:21: STYLE: no blank before trailing delimiter: Li .Er ENOENT ) ;
mandoc: groff_mdoc.7.man:1403:24: STYLE: no blank before trailing delimiter: Li .Ev PRINTER ) ) ,
mandoc: groff_mdoc.7.man:1436:15: STYLE: no blank before trailing delimiter: Li .Fl \- ,
mandoc: groff_mdoc.7.man:1438:18: STYLE: no blank before trailing delimiter: Li .Fl xyz ) ,
mandoc: groff_mdoc.7.man:1440:12: STYLE: no blank before trailing delimiter: Li .Fl |
mandoc: groff_mdoc.7.man:1527:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:1535:21: STYLE: no blank before trailing delimiter: Li .Fn strlen ) ,
mandoc: groff_mdoc.7.man:1537:38: STYLE: no blank before trailing delimiter: Li .Fn align \[dq]char *ptr\[dq] ,
mandoc: groff_mdoc.7.man:1627:25: STYLE: no blank before trailing delimiter: Li .Fa d_namlen ) ) ,
mandoc: groff_mdoc.7.man:1780:5: WARNING: unknown library name: Lb libgpib
mandoc: groff_mdoc.7.man:1788:5: WARNING: unknown library name: Lb libipx
mandoc: groff_mdoc.7.man:1888:2: WARNING: skipping paragraph macro: Pp at the end of Ss
mandoc: groff_mdoc.7.man:1902:21: STYLE: no blank before trailing delimiter: Li .Li M1 M2 M3 ;
mandoc: groff_mdoc.7.man:1904:23: STYLE: no blank before trailing delimiter: Li .Li cntrl\-D ) ,
mandoc: groff_mdoc.7.man:1959:20: STYLE: no blank before trailing delimiter: Li .Nm foo ) ) ,
mandoc: groff_mdoc.7.man:1961:12: STYLE: no blank before trailing delimiter: Li .Nm :
mandoc: groff_mdoc.7.man:1990:19: STYLE: no blank before trailing delimiter: Li .Op Fl k ) .
mandoc: groff_mdoc.7.man:1994:29: STYLE: no blank before trailing delimiter: Li .Op Fl k Ar kookfile ,
mandoc: groff_mdoc.7.man:1998:40: STYLE: no blank before trailing delimiter: Li .Op Fl c Ar objfil Op Ar corfil ,
mandoc: groff_mdoc.7.man:2054:28: STYLE: no blank before trailing delimiter: Li .Pa /tmp/fooXXXXX ) .
mandoc: groff_mdoc.7.man:2074:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:2092:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:2125:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:2199:32: STYLE: no blank before trailing delimiter: Li .Vt extern char *optarg ;
mandoc: groff_mdoc.7.man:2214:21: STYLE: no blank before trailing delimiter: Li .Va settimer ,
mandoc: groff_mdoc.7.man:2216:33: STYLE: no blank before trailing delimiter: Li .Va \[dq]int *prt\[dq] ) :
mandoc: groff_mdoc.7.man:2218:35: STYLE: no blank before trailing delimiter: Li .Va \[dq]char s\[dq] ] ) ) ,
mandoc: groff_mdoc.7.man:2237:2: WARNING: missing section argument: Xr mdoc
mandoc: groff_mdoc.7.man:2238:17: STYLE: no blank before trailing delimiter: Li .Xr mdoc ,
mandoc: groff_mdoc.7.man:2239:2: WARNING: missing section argument: Xr mdoc
mandoc: groff_mdoc.7.man:2242:21: STYLE: no blank before trailing delimiter: Li .Xr xinit 1x ;
mandoc: groff_mdoc.7.man:2250:2: WARNING: first section is not "NAME": Sh General text domain
mandoc: groff_mdoc.7.man:2260:15: STYLE: no blank before trailing delimiter: Li .At v6 .
mandoc: groff_mdoc.7.man:2254:2: WARNING: skipping paragraph macro: Pp after Ss
mandoc: groff_mdoc.7.man:2279:16: STYLE: no blank before trailing delimiter: Li .Bx 4.3 .
mandoc: groff_mdoc.7.man:2272:2: WARNING: skipping paragraph macro: Pp after Ss
mandoc: groff_mdoc.7.man:2302:16: STYLE: no blank before trailing delimiter: Li .Nx 1.4 .
mandoc: groff_mdoc.7.man:2296:2: WARNING: skipping paragraph macro: Pp after Ss
mandoc: groff_mdoc.7.man:2321:16: STYLE: no blank before trailing delimiter: Li .Fx 2.2 .
mandoc: groff_mdoc.7.man:2315:2: WARNING: skipping paragraph macro: Pp after Ss
mandoc: groff_mdoc.7.man:2340:16: STYLE: no blank before trailing delimiter: Li .Dx 1.4 .
mandoc: groff_mdoc.7.man:2334:2: WARNING: skipping paragraph macro: Pp after Ss
mandoc: groff_mdoc.7.man:2353:2: WARNING: skipping paragraph macro: Pp after Ss
mandoc: groff_mdoc.7.man:2363:2: WARNING: skipping paragraph macro: Pp after Ss
mandoc: groff_mdoc.7.man:2373:2: WARNING: skipping paragraph macro: Pp after Ss
mandoc: groff_mdoc.7.man:2393:24: STYLE: no blank before trailing delimiter: Li .Em exceed 1024 .
mandoc: groff_mdoc.7.man:2395:27: STYLE: no blank before trailing delimiter: Li .Em vide infra ) ) ,
mandoc: groff_mdoc.7.man:2496:2: WARNING: missing section argument: Xr nroff
mandoc: groff_mdoc.7.man:2534:25: STYLE: no blank before trailing delimiter: Li .Aq Pa ctype.h ) ,
mandoc: groff_mdoc.7.man:2550:21: STYLE: no blank before trailing delimiter: Li .Qq string ) ,
mandoc: groff_mdoc.7.man:2552:23: STYLE: no blank before trailing delimiter: Li .Qq string Ns ),
mandoc: groff_mdoc.7.man:2633:2: WARNING: skipping paragraph macro: Pp before Bl
mandoc: groff_mdoc.7.man:2769:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:2771:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:2810:2: WARNING: missing -width in -tag list, using 6n: Bl -tag
mandoc: groff_mdoc.7.man:2835:2: WARNING: missing -width in -tag list, using 6n: Bl -tag
mandoc: groff_mdoc.7.man:2870:2: WARNING: skipping paragraph macro: Pp at the end of Ss
mandoc: groff_mdoc.7.man:2873:2: WARNING: first section is not "NAME": Sh Page structure domain
mandoc: groff_mdoc.7.man:3284:2: WARNING: missing section argument: Xr nroff
mandoc: groff_mdoc.7.man:3370:2: WARNING: missing section argument: Xr troff/
mandoc: groff_mdoc.7.man:3403:2: WARNING: missing section argument: Xr troff
mandoc: groff_mdoc.7.man:3296:2: WARNING: skipping paragraph macro: Pp before Bl
mandoc: groff_mdoc.7.man:3617:2: WARNING: skipping paragraph macro: Pp before Bl
mandoc: groff_mdoc.7.man:3723:2: WARNING: skipping paragraph macro: Pp before Bl
mandoc: groff_mdoc.7.man:3907:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:3997:2: WARNING: first section is not "NAME": Sh Miscellaneous macros
mandoc: groff_mdoc.7.man:4015:2: STYLE: useless macro: Bt
mandoc: groff_mdoc.7.man:4034:9: STYLE: no blank before trailing delimiter: Ql File:
mandoc: groff_mdoc.7.man:4081:2: STYLE: useless macro: Ud
mandoc: groff_mdoc.7.man:4088:2: WARNING: first section is not "NAME": Sh Predefined strings
mandoc: groff_mdoc.7.man:4169:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:4177:2: WARNING: first section is not "NAME": Sh Diagnostics
mandoc: groff_mdoc.7.man:4184:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:4196:2: WARNING: first section is not "NAME": Sh Formatting with groff, troff, and nroff
mandoc: groff_mdoc.7.man:4200:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:4207:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:4251:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:4295:2: WARNING: first section is not "NAME": Sh Files
mandoc: groff_mdoc.7.man:4307:2: STYLE: useless macro: Tn
mandoc: groff_mdoc.7.man:4323:2: WARNING: first section is not "NAME": Sh See also
mandoc: groff_mdoc.7.man:4331:2: WARNING: first section is not "NAME": Sh Bugs

Bjarni Ingi Gislason <bjarniig>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by gbranden (Updated the item)
  • -email is unavailable- added by schwarze (Posted a comment)
  • -email is unavailable- added by bjarniig (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follow 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-06-10 gbranden CategoryNone Macro package mdoc
        Assigned toNone schwarze
    2020-11-05 schwarze Severity3 - Normal 1 - Wish
        StatusNone Invalid
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-bb6a.
    Corresponding source code