Re: [PATCH] dash: man pages: fix formatting

[Herbert Xu <herbert@xxxxxxxxxxxxxxxxxxx>]

Bjarni Ingi Gislason <bjarniig@xxxxxxxxx> wrote:
>  Fix formatting according to the output of "mandoc -Tlint".
> 
> Overview:
> 
>  Start each sentence on a new line.
> 
>  Protect a punctuation mark in a macro call with '\&'.
> 
>  Trim trailing space.
> 
>  Add a missing comma in a row of words.
> 
>  Use an en-dash instead of '--' if there is space around it.
>  An em-dash is used without space around it.
> 
>  Comment out ".Pp" macros that do nothing.
> 
>  Split long sentences after a punctuation mark.
> 
>  Remove a "-width ..." for a ".Bl -item" macro, as it has no influence
> 
> Details:
> 
> mandoc: ./src/bltin/echo.1:69:38: WARNING: new sentence, new line
> mandoc: ./src/bltin/echo.1:75:35: WARNING: new sentence, new line
> mandoc: ./src/bltin/printf.1:205:12: WARNING: skipping empty macro: No
> mandoc: ./src/bltin/printf.1:284:28: STYLE: whitespace at end of input line
> mandoc: ./src/bltin/printf.1:288:20: STYLE: whitespace at end of input line
> mandoc: ./src/bltin/printf.1:293:28: STYLE: whitespace at end of input line
> mandoc: ./src/bltin/printf.1:353:31: WARNING: new sentence, new line
> mandoc: ./src/bltin/printf.1:74:2: STYLE: useless macro: Tn
> mandoc: ./src/bltin/printf.1:111:2: STYLE: useless macro: Tn
> mandoc: ./src/bltin/printf.1:116:2: STYLE: useless macro: Tn
> mandoc: ./src/bltin/printf.1:279:2: STYLE: useless macro: Tn
> mandoc: ./src/bltin/printf.1:334:2: WARNING: unusual Xr punctuation: none before vis(3)
> mandoc: ./src/bltin/printf.1:334:2: WARNING: unusual Xr order: vis(3) after printf(9)
> mandoc: ./src/bltin/printf.1:348:2: STYLE: useless macro: Tn
> mandoc: ./src/bltin/printf.1:333:6: STYLE: referenced manual not found: Xr printf 9
> mandoc: ./src/bltin/printf.1:334:6: STYLE: referenced manual not found: Xr vis 3
> mandoc: ./src/bltin/test.1:46:16: WARNING: skipping empty macro: Cm
> mandoc: ./src/bltin/test.1:105:5: STYLE: useless macro: Tn
> mandoc: ./src/dash.1:1180:58: WARNING: new sentence, new line
> mandoc: ./src/dash.1:1186:13: STYLE: whitespace at end of input line
> mandoc: ./src/dash.1:1194:38: WARNING: new sentence, new line
> mandoc: ./src/dash.1:1200:35: WARNING: new sentence, new line
> mandoc: ./src/dash.1:1474:71: WARNING: new sentence, new line
> mandoc: ./src/dash.1:1783:62: WARNING: new sentence, new line
> mandoc: ./src/dash.1:2061:22: WARNING: new sentence, new line
> mandoc: ./src/dash.1:2311:54: WARNING: new sentence, new line
> mandoc: ./src/dash.1:2315:63: WARNING: new sentence, new line
> mandoc: ./src/dash.1:37:2: WARNING: prologue macros out of order: Dt after Os
> mandoc: ./src/dash.1:87:2: STYLE: useless macro: Tn
> mandoc: ./src/dash.1:94:2: STYLE: useless macro: Tn
> mandoc: ./src/dash.1:343:2: STYLE: useless macro: Tn
> mandoc: ./src/dash.1:442:17: STYLE: verbatim "--", maybe consider using \(em
> mandoc: ./src/dash.1:466:2: STYLE: useless macro: Tn
> mandoc: ./src/dash.1:581:34: STYLE: verbatim "--", maybe consider using \(em
> mandoc: ./src/dash.1:583:25: STYLE: verbatim "--", maybe consider using \(em
> mandoc: ./src/dash.1:585:43: STYLE: verbatim "--", maybe consider using \(em
> mandoc: ./src/dash.1:595:11: STYLE: verbatim "--", maybe consider using \(em
> mandoc: ./src/dash.1:618:29: STYLE: verbatim "--", maybe consider using \(em
> mandoc: ./src/dash.1:697:2: WARNING: skipping paragraph macro: Pp before Bd
> mandoc: ./src/dash.1:1344:2: STYLE: useless macro: Tn
> mandoc: ./src/dash.1:1420:2: WARNING: skipping paragraph macro: Pp before Bd
> mandoc: ./src/dash.1:1434:2: WARNING: skipping paragraph macro: Pp before Bd
> mandoc: ./src/dash.1:1556:2: STYLE: useless macro: Tn
> mandoc: ./src/dash.1:1587:2: STYLE: useless macro: Tn
> mandoc: ./src/dash.1:1746:2: STYLE: useless macro: Tn
> mandoc: ./src/dash.1:1875:5: STYLE: useless macro: Tn
> mandoc: ./src/dash.1:1525:2: WARNING: skipping paragraph macro: Pp before It
> mandoc: ./src/dash.1:2182:2: WARNING: skipping paragraph macro: Pp before It
> mandoc: ./src/dash.1:2247:2: WARNING: sections out of conventional order: Sh ENVIRONMENT
> mandoc: ./src/dash.1:2323:11: WARNING: skipping -width argument: Bl -item
> mandoc: ./src/dash.1:2347:31: STYLE: consider using OS macro: Nx
> mandoc: ./src/dash.1:92:6: STYLE: referenced manual not found: Xr ksh 1 (2 times)
> mandoc: ./src/dash.1:253:6: STYLE: referenced manual not found: Xr emacs 1
> mandoc: ./src/dash.1:2253:9: STYLE: referenced manual not found: Xr passwd 4
> mandoc: ./src/dash.1:2330:6: STYLE: referenced manual not found: Xr csh 1
> 
> Signed-off-by: Bjarni Ingi Gislason <bjarniig@xxxxxxxxx>
> ---
> src/bltin/echo.1   |  6 +++--
> src/bltin/printf.1 | 13 ++++++-----
> src/bltin/test.1   |  2 +-
> src/dash.1         | 57 +++++++++++++++++++++++++++-------------------
> 4 files changed, 45 insertions(+), 33 deletions(-)

Patch applied.  Thanks.
-- 
Email: Herbert Xu <herbert@xxxxxxxxxxxxxxxxxxx>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt