mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.41 and 1.60

version 1.41, 2010/08/18 08:39:54

version 1.60, 2010/10/17 21:10:53

Line 36

\\ must behave in a macro def like in a macro argument,

and when using the macro, it must expand yet again.

- look at bsd.lv tbl(1)

- implement basic non-parametric .de to support e.g. sox(1)

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

.de SP

also look at the mail from Thomas Klausner wiz at NetBSD

.if t .sp .5

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

.if n .sp

joerg@ has patches for this somewhere...

.de EX

.SP

.nf

.ft CW

.de EE

.ft R

.SP

.fi

reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200

- port OpenBSD tbl integration bsd.lv, probably cleaning it up

- 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

roff stuff. Figure out to what extent we can cope.

Line 56

Line 69

- 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 67

Line 87

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

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

- 'br\} doesn't correctly close scope.

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

Noted by joerg@, 28/7/2010.

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

jmc@ a thousand years ago.

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

* formatting issues: ugly output

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

Line 86

Line 107

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.

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

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

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

* formatting issues: gratuitious differences

Line 96

Line 118

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"

Line 133

Line 136

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

Line 144

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,

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

there is no point in rendering two commata,

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

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

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

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

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

* performance issues

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

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

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

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

* 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

- Now that `ds' is minimally supported, we can get rid of some

predefined strings. \*(C+ has already been thrown out. Track these

down and whack them. Look in e.g. gcc.1 for the top-level `ds'

invocations. These are reproduced across most crappy GNU manuals.

CVSweb