mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.31 and 1.57

version 1.31, 2010/07/19 09:21:58

version 1.57, 2010/09/27 22:42:48

Line 1

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

* Official mandoc TODO. May not be quite up to date.

* Official mandoc TODO.

* $Id$

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

Line 40

from kristaps@ Fri, 11 Sep 2009 17:10:53 +0200

also look at the mail from Thomas Klausner wiz at NetBSD

on Wed, 2 Jun 2010 11:01:29 +0200

joerg@ has patches for this somewhere...

- look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)

These are a weird mixture of man(7) and custom autogenerated low-level

Line 55

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 62

Line 70

- prohibit `Nm' from having non-text HEAD children

(e.g., NetBSD mDNSShared/dns-sd.1)

(mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)

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

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

- Have `Sh', `It', `Ss' and others complain if `Pp' is invoked prior to

close (in the post validation) or prior to open (pre). This noted by

jmc@ a thousand years ago.

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

* formatting issues: ugly output

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

Line 70

Line 85

- 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

- .Pp before and after .Sh (and .Ss) produces a spurious blank line;

- in enclosures, mandoc sometimes fancies a bogus end of sentence

reported by jmc@ Thu, 15 Jul 2010 23:00:28 +0100

reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059

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

* formatting issues: gratuitious differences

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

- none reported right now (yet schwarze@ knows of some)

- .%T should be quoted, not underlined, when .%J is also present,

to better distinguish the contents of .%T and .%J,

see for example OpenBSD cat(1)

- .It ${name Ns [ selector ] Ns }

should be "${name[selector]}" not "${name [selector]}"

This is parsed as

text("${name") text("[") Ns() text(selector)...

Opening punctuation should not fall out of .Ns.

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)

- .No text No ) is "text )", not "text)"

see the terrible example

case word in [[(] pattern [| pattern] ... ) list ;; ] ... esac

in OpenBSD ksh(1)

- .Sm should *not* produce as a blank line in .Bd -literal

see for example "Brace expansion" in OpenBSD ksh(1)

- The characters "|" and "\*(Ba" should never be bold,

not even in the middle of a word, e.g. ".Cm b\*(Bac" in

"mknod [-m mode] name b|c major minor"

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), 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).

- .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).

- The \& zero-width character counts as output.

That is, when it is alone on a line between two .Pp,

we want three blank lines, not two as in mandoc.

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

* performance issues

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

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

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

- improve hashing mechanism for macros (quite important: performance)

- improve hashing mechanism for characters (not as important)

- the PDF file is HUGE: this can be reduced by using relative offsets

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

* structural issues

CVSweb