Project

General

Profile

Actions
Copy link

Bug #11194

closed

syseventadm.1m: ERROR: using macro argument outside macro

Added by Michal Nowak over 4 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Michal Nowak
Category:
manpage - manual pages
Start date:
Due date:
% Done:

100%

Estimated time:
Difficulty:
Bite-size
Tags:
Gerrit CR:
External Bug:

Description

Linting syseventadm.1m with mandoc 1.14.5 (https://www.illumos.org/issues/11190) reveals following errors:

$ 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: \${

Related issues

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

Actions
Related to illumos gate - Feature #11195: Lint old man pages for errors with mandocClosedMichal Nowak

Actions
Actions
Copy link
 #1

Updated by Michal Nowak over 4 years ago

Actions
Copy link
 #2

Updated by Michal Nowak over 4 years ago

  • Related to Feature #11195: Lint old man pages for errors with mandoc added
Actions
Copy link
 #3

Updated by Michal Nowak over 4 years ago

Solution to this matter is to use $ directly without escaping.

RB: https://illumos.org/rb/r/1973

Actions
Copy link
 #4

Updated by Electric Monk over 4 years ago

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

git commit 0ae8c37dc7709962a2fc99f02369b11707cccba0

commit  0ae8c37dc7709962a2fc99f02369b11707cccba0
Author: Michal Nowak <mnowak@startmail.com>
Date:   2019-06-13T19:08:35.000Z

    11194 syseventadm.1m: ERROR: using macro argument outside macro
    Reviewed by: Andy Fiddaman <omnios@citrus-it.co.uk>
    Reviewed by: Robert Mustacchi <rm@joyent.com>
    Approved by: Dan McDonald <danmcd@joyent.com>

Actions
Copy link
 #5

Updated by Michal Nowak over 4 years ago

Testing

Before:

$ 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: \${

The -R $ALTROOT portion is not displayed correctly with updated mandoc.

After:

$ mandoc -Tlint -Werror /usr/share/man/man1m/syseventadm.1m 

$ mandoc -l /usr/share/man/man1m/syseventadm.1m 
...
         # syseventadm add -R $ALTROOT -v MYCO -c EC_ENV -s ESC_ENV_TEMP \
              /opt/MYCOenv/bin/ec_env_temp ${class} ${subclass} ${pathname}
...
         # syseventadm remove -R $ALTROOT -v MYCO -c EC_ENV -s ESC_ENV_TEMP \
              /opt/MYCOenv/bin/ec_env_temp ${class} ${subclass} ${pathname}
...
         # syseventadm list -v MYCO -c EC_ENV -s ESC_ENV_TEMP \
              vendor=MYCO class=EC_ENV subclass=ESC_ENV_TEMP \
              /opt/MYCOenv/bin/ec_env_temp ${class} ${subclass} ${pathname}
...

Actions
Copy link

Also available in: Atom PDF