mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.38 and 1.46

version 1.38, 2010/08/15 16:38:35

version 1.46, 2010/09/15 13:10:30

Line 56

- explicitly disallow nested `Bl -column', which would clobber internal

flags defined for struct mdoc_macro

- inside `.Bl -column' phrases, punctuation is handled like normal

text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."

- inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'

is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."

but should give "ab ."

- set a meaningful default if no `Bl' list type is assigned

- have a blank `It' head for `Bl -tag' not puke

Line 66

Line 73

- allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments

noted by Alex Kozlov 08/06/10 23:05

************************************************************************

* formatting issues: ugly output

************************************************************************

Line 74

Line 81

- perl(1) SYNOPSIS looks bad; reported by deraadt@

1) man(7) seems to need SYNOPSIS .Nm blocks, too

- In .Bl -column,

.It Em Authentication<tab>Key Length

ought to render "Key Length" with emphasis, too,

see OpenBSD iked.conf(5).

- empty phrases in .Bl column produce too few blanks

try e.g. .Bl -column It Ta Ta

reported by millert Fri, 02 Apr 2010 16:13:46 -0400

- %A doesn't put an "and" before the final author name.

************************************************************************

* formatting issues: gratuitious differences

************************************************************************

Line 95

Line 105

Opening punctuation should not fall out of .Ns.

see for example OpenBSD csh(1)

- .%A should append the last author with " and " (if there are two)

or ", and " (if there are more), not ", "

see for example OpenBSD csh(1)

- In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet

is just "o\bo".

see for example OpenBSD ksh(1)

Line 117

Line 123

in OpenBSD ksh(1)

- A bogus .Pp between two .It must not produce a double blank line,

see between -R and -r in OpenBSD rm(1).

see between -R and -r in OpenBSD rm(1), before "update" in mount(8),

or in DIAGNOSTICS in init(8).

- .Bd -literal and .Bd -unfilled are *not* identical.

In -literal, tabs are 8 spaces.

In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.

See the CCDF_* display in OpenBSD ccdconfig(8).

- In .Bd -unfilled, .Pp should produce one blank line, not two;

see the ccd.conf display in OpenBSD ccdconfig(8).

- .Nx 1.0a

should be "NetBSD 1.0A", not "NetBSD 1.0a",

see OpenBSD ccdconfig(8).

- In .Bl -tag, if a tag exceeds the right margin and must be continued

on the next line, it must be indented by -width, not width+1;

see "rule block|pass" in OpenBSD ifconfig(8).

- When .%T is used outside an .Rs context and with a trailing comma,

there is no point in rendering two commata,

see the first paragraph of the DESCRIPTION in OpenBSD mount_nfs(8).

- When .%T is used outside an .Rs context and without a trailing comma,

no comma should be rendered at all,

see the first paragraph of the DESCRIPTION in OpenBSD exports(5).

- Bogus .Pp before .Bl should not cause a double blank line,

see "The route utility provides the following simple commands:"

in OpenBSD route(8).

- In -T[x]html, Rs/Re need a div.

************************************************************************

* performance issues

************************************************************************

Line 144 Several areas can be cleaned up to make mandoc even fa

Line 181 Several areas can be cleaned up to make mandoc even fa

.Bl -tag -width "\eD{format}XX" -compact

in OpenBSD ksh(1) gives the wrong width

because "\e" is one character in groff, two in mandoc

CVSweb