mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.101 and 1.116

version 1.101, 2011/04/16 22:35:26

version 1.116, 2011/07/03 22:40:10

Line 7

* parser bugs

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

- ".\}" on its own line gets translated to bare ".\&"

which forces pset() into man(7)

and then triggers an unknown macro error

reported by naddy@ Sun, 3 Jul 2011 21:52:24 +0200

- .TP before .SH is still FATAL in man(7)

reported by brad@ Sat, 15 Jan 2011 15:54:54 -0500

- the roff parser doesn't tolerate additional characters between

a macro and the \} terminating a conditional block, e.g.

.if n \{

.br \}

reported by ulrich spoerlein Tue, 19 Oct 2010 20:39:50 +0200

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

* formatter bugs

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

Line 56

Line 55

- \c (interrupted text) occurs in chat(8)

- \f(CW (constant width font) occurs in rsyncd.conf(5).

I think we should treat unknown/unavailable fonts as \fR

such that switching back with \fP works correctly -

and doesn't revert the _previous_ \fP.

--- missing mdoc features ----------------------------------------------

- fix bad block nesting involving multiple identical explicit blocks

Line 96

Line 90

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

flags defined for struct mdoc_macro

- In .Bl -column .It, the end of the line probably has to be regarded

as an implicit .Ta, if there could be one, see the following mildly

ugly code from login.conf(5):

.Bl -column minpasswordlen program xetcxmotd

.It path Ta path Ta value of Dv _PATH_DEFPATH

.br

Default search path.

reported by Michal Mazurek <akfaew at jasminek dot net>

via jmc@ Thu, 7 Apr 2011 16:00:53 +0059

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

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

Line 111

Line 115

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

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

- When there is free text in the SYNOPSIS and that free text contains

the .Nm macro, groff somehow understands to treat the .Nm as an in-line

macro, while mandoc treats it as a block macro and breaks the line.

No idea how the logic for distinguishing in-line and block instances

should be, needs investigation.

uqs@ Thu, 2 Jun 2011 11:03:51 +0200

uqs@ Thu, 2 Jun 2011 11:33:35 +0200

--- missing man features -----------------------------------------------

- .RS/.RE can be nested, see e.g. the x11/fluxbox manuals

noticed by dcoppa@ Wed, Apr 13, 2011 at 04:58:14PM +0200:

- groff an-ext.tmac macros (.UR, .UE) occur in xine(5)

reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500

- .SH implies .fi, see e.g. sasl_setpass(1)

reported by naddy@ Sun, 3 Jul 2011 23:55:17 +0200

--- missing tbl features -----------------------------------------------

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

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

*** sox(1) still doesn't work, tbl(1) errors need investigation

- allow standalone `.' to be interpreted as an end-of-layout

delimiter instead of being thrown away as a no-op roff line

reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST

--- missing misc features ----------------------------------------------

- clean up escape sequence handling, creating three classes:

Line 191

Line 207

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

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

* formatting issues: gratuitious differences

* formatting issues: gratuitous differences

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

- .Rv (and probably .Ex) print different text if an `Nm' has been named

Line 214

Line 230

Also have `It' complain if `Pp' is invoked at certain times (not

-compact?).

- .Pp between two .It in .Bl -column should produce one,

not two blank lines, see e.g. login.conf(5).

reported by jmc@ Sun, 17 Apr 2011 14:04:58 +0059

- If the *first* line after .It is .Pp, break the line right after

the tag, do not pad with space characters before breaking.

See the description of the a, c, and i commands in sed(1).

Line 266

Line 286

see for example named-checkconf(8).

- In man(7), the sequence

regular text

.RS

.IP

should have a blank line between the text and the beginning of the

indented paragraph, see for example sudo(1).

- In man(7), the sequence

.SH HEADER

.PP

Line 283

Line 296

- In man(7), the sequence

regular text

.PP

.RS

indented text

should produce one blank line between the regular and indented texts,

see for example rsync(1), and

.RE

.PP

.RS

should produce two,not one blank lines.

Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200

- In man(7), the sequence

regular text

.IP

.IP "tag"

indented text

Line 315

Line 314

should produce one, not three blank lines.

Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200

- At least sometimes, .sp is ignored right after .SH; see named.conf(5).

- trailing whitespace must be ignored even when followed by a font escape,

see for example

makes

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

Line 336 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

- instead of re-initialising the roff predefined-strings set before each

parse, create a read-only version the first time and copy it

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

* structural issues

CVSweb