OS-7821: mandoc should allow ERRORS section in all man section 7 variants

Details

Issue Type:Improvement
Priority:4 - Normal
Status:Resolved
Created at:2019-06-05T22:41:45.981Z
Updated at:2019-06-06T22:15:40.033Z

People

Created by:Former user
Reported by:Former user
Assigned to:Former user

Resolution

Fixed: A fix for this issue is checked into the tree and tested.
(Resolution Date: 2019-06-06T22:15:40.020Z)

Fix Versions

2019-07-04 Verdukianism (Release Date: 2019-07-04)

Description

Currently mandoc will complain if it finds an ERRORS section in a manpage that's not in it's list of blessed sections - which is currently 2, 3, 4, 7I and 9:

For example:

mandoc: ufm.7d:160:2: WARNING: unexpected section: Sh ERRORS for 2, 3, 4, 7I, 9 only

There are legitimate reasons to have an ERRORS section in all of the Section 7 variants. Thus, this ticket is to cover loosening this restriction accordingly.

Comments

Comment by Former user
Created at 2019-06-06T18:09:39.579Z

Testing

I tested the change by using the modified mandoc in a dev workspace that contains a man page in section 7d that contains an ERRORS section. I also did a full smartos-build and verified that it was clean.


Comment by Jira Bot
Created at 2019-06-06T22:14:49.013Z

illumos-joyent commit 31e9b8d8f301a255a59ee8af1451348da6be8abf (branch master, by Rob Johnston)

OS-7821 mandoc should allow ERRORS section in all man section 7 variants
Reviewed by: Robert Mustacchi <robert.mustacchi@joyent.com>
Approved by: Joshua M. Clulow <josh@sysmgr.org>