Project

General

Profile

Actions
Copy link

Bug #11191

closed

zfs.1m: UNSUPP: unsupported escape sequence: \?

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 zfs.1m with mandoc 1.14.5 (https://www.illumos.org/issues/11190) reveals following UNSUPP warnings:

$ mandoc -Tlint -Wwarning ~/ws/illumos-gate/usr/src/man/man1m/zfs.1m 
mandoc: /export/home/newman/ws/illumos-gate/usr/src/man/man1m/zfs.1m:40:8: UNSUPP: unsupported escape sequence: \?
mandoc: /export/home/newman/ws/illumos-gate/usr/src/man/man1m/zfs.1m:1864:11: UNSUPP: unsupported escape sequence: \?

Related issues

Related to illumos gate - Feature #11190: Update mandoc to 1.14.5ClosedMichal 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

Solution (https://man.openbsd.org/mandoc.1#Warnings_related_to_macros_and_nesting) to this matter is to insert & into the "escape sequence", e.g. \? → \&?.

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

Actions
Copy link
 #3

Updated by Electric Monk over 4 years ago

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

git commit cf26d3683ae21b85c4d302e60723a08e85e2574a

commit  cf26d3683ae21b85c4d302e60723a08e85e2574a
Author: Michal Nowak <mnowak@startmail.com>
Date:   2019-06-13T19:06:14.000Z

    11191 zfs.1m: UNSUPP: unsupported escape sequence: \?
    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
 #4

Updated by Michal Nowak over 4 years ago

Testing
With mandoc 1.14.5.

Before:

$ mandoc -Tlint -Wwarning ~/ws/illumos-gate/usr/src/man/man1m/zfs.1m 
mandoc: /export/home/newman/ws/illumos-gate/usr/src/man/man1m/zfs.1m:40:8: UNSUPP: unsupported escape sequence: \?
mandoc: /export/home/newman/ws/illumos-gate/usr/src/man/man1m/zfs.1m:1864:11: UNSUPP: unsupported escape sequence: \?

After:

$ mandoc -Tlint -Wwarning /usr/share/man/man1m/zfs.1m

$ mandoc -l /usr/share/man/man1m/zfs.1m

ZFS(1M)                      Maintenance Commands                      ZFS(1M)

NAME
     zfs – configures ZFS file systems

SYNOPSIS
     zfs [-?]
...
     zfs -?
       Displays a help message.

Actions
Copy link

Also available in: Atom PDF