Project

General

Profile

Feature #11195

Lint old man pages for errors with mandoc

Added by Michal Nowak 5 months ago. Updated 4 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
tests
Start date:
Due date:
% Done:

100%

Estimated time:
Difficulty:
Medium
Tags:

Description

Currently in usr/src/man/Makefile.man a man page check via mandoc -Tlint -Wwarning is executed against new mandoc-style man pages.

However, even old-style man pages can be checked. Currently makes sense to check them for errors (-Werror) as only one man page does not comply with mandoc 1.14.5 (https://www.illumos.org/issues/11190):

$ mandoc -Tlint -Werror ~/ws/illumos-gate/usr/src/man/man1m/syseventadm.1m 
mandoc: /export/home/newman/ws/illumos-gate/usr/src/man/man1m/syseventadm.1m:289:22: ERROR: using macro argument outside macro: \$A
mandoc: /export/home/newman/ws/illumos-gate/usr/src/man/man1m/syseventadm.1m:309:25: ERROR: using macro argument outside macro: \$A
mandoc: /export/home/newman/ws/illumos-gate/usr/src/man/man1m/syseventadm.1m:310:58: ERROR: using macro argument outside macro: \${
mandoc: /export/home/newman/ws/illumos-gate/usr/src/man/man1m/syseventadm.1m:310:45: ERROR: using macro argument outside macro: \${
mandoc: /export/home/newman/ws/illumos-gate/usr/src/man/man1m/syseventadm.1m:310:35: ERROR: using macro argument outside macro: \${

It's a genuine display problem with mandoc 1.14.5 reveled by the check.


Related issues

Related to illumos gate - Feature #11190: Update mandoc to 1.14.5Closed

Actions
Related to illumos gate - Bug #11194: syseventadm.1m: ERROR: using macro argument outside macroClosed

Actions

History

#1

Updated by Michal Nowak 5 months ago

#2

Updated by Michal Nowak 5 months ago

  • Related to Bug #11194: syseventadm.1m: ERROR: using macro argument outside macro added
#4

Updated by Electric Monk 4 months ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100

git commit e6645893d65132754e10d2b7e2c6ecc5ea0107a4

commit  e6645893d65132754e10d2b7e2c6ecc5ea0107a4
Author: Michal Nowak <mnowak@startmail.com>
Date:   2019-06-13T19:09:16.000Z

    11195 Lint old man pages for errors with mandoc
    Reviewed by: Andy Fiddaman <omnios@citrus-it.co.uk>
    Reviewed by: Robert Mustacchi <rm@joyent.com>
    Approved by: Dan McDonald <danmcd@joyent.com>

#5

Updated by Michal Nowak 4 months ago

Testing

Full illumos-gate rebuild passed.

Log is bigger by 8k lines (old man pages which were not previously checked) of this sort:

checking syseventadm.1m

For my 50 minutes build it may be 1-2 minutes longer due to the checking.

Also available in: Atom PDF