Project

General

Profile

Bug #8078

Clean up mandoc lint

Added by Peter Tribble almost 3 years ago. Updated almost 3 years ago.

Status:
New
Priority:
Normal
Assignee:
Category:
manpage - manual pages
Start date:
2017-04-16
Due date:
% Done:

0%

Estimated time:
Difficulty:
Medium
Tags:
needs-triage

Description

Running git-pbchk runs mandoc lint which can generate a number
of errors. It would be nice to fix these once and for all.

Across all our man pages at the present time, we have the following number of problems (across 3706 different man pages):

2 WARNING: skipping paragraph macro: br after SH
3 WARNING: skipping paragraph macro: br after SS
109 WARNING: whitespace at end of input line
842 UNSUPP: unsupported control character: 0x7
2168 WARNING: skipping paragraph macro: sp after SS
19352 WARNING: skipping paragraph macro: sp after SH

It would be fairly straightforward to automatically fix those.

This ignores the following types of warnings:

invalid escape sequence
cannot parse date, using it verbatim
lower case character in document title

Which either need manual intervention or which would change the
output, so are deferred to a separate issue.

History

#1

Updated by Yuri Pankov almost 3 years ago

It's not really worth the effort, with every new version some new warnings are introduced, so this sounds like an endless source of repo churn. Fixing what `git pbchk` reports should be just enough, as all these roff warnings don't really have any effect on the output.

Also available in: Atom PDF