mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.31 and 1.38

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

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

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 62

Line 63

- 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

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

* formatting issues: ugly output

Line 74

Line 78

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;

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

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

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

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

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

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

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

* performance issues

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

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

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

- improve hashing mechanism for characters (not as important)

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

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

* structural issues

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

- rendering frontend code can calculate widths only for plain strings,

not for strings containing escape sequences. For example, this

hinders calculation of the indent required for .Nm \&[ in text(1).

comments from kristaps@ Wed, 21 Jul 2010 23:26:08 +0200

- another example of the same problem:

.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