mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.119 and 1.139

version 1.119, 2011/07/09 10:26:57

version 1.139, 2012/07/18 11:11:12

Line 4

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

* 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

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

* formatter bugs

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

- tbl(7): Horizontal and vertical lines are formatted badly:

With the box option, there is too much white space at the end of cells.

Horizontal lines from "=" lines are a bit too long.

yuri dot pankov at gmail dot com Thu, 14 Apr 2011 05:45:26 +0400

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

* missing features

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

--- missing roff features ----------------------------------------------

- .if n \{

- roff.c should treat \n(.H>23 and \n(.V>19 in the pod2man(1)

.br\}

preamble as true, see for example AUTHORS in MooseX::Getopt.3p

should cause an extra space to be raised.

reported by Andreas Voegele <mail at andreasvoegele dot com>

Tue, 22 Nov 2011 15:34:47 +0100 on ports@

- .ad (adjust margins)

.ad l -- adjust left margin only (flush left)

Line 51

Line 31

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

- xloadimage(1) wants .ti (temporary indent), rep by naddy@

reported again by bentley@ in nmh(1) Mon, 23 Apr 2012 13:38:28 -0600

also uses .ce (center N lines) and .fc (field control)

- .ta (tab settings) occurs in ircbug(1) and probably gnats(1)

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

- pod2man expects `tr' to be implemented for \*(-- to work

- \c (interrupted text) should prevent the line break

even inside .Bd literal; that occurs in chat(8)

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

- using undefined strings or macros defines them to be empty

wl@ Mon, 14 Nov 2011 14:37:01 +0000

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

Line 185

Line 169

so far, we only have it in roff(7) and man(7)

reminded by millert@ Thu, 09 Dec 2010 17:29:52 -0500

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

reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200

- empty phrases in .Bl column produce too few blanks

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

Line 221

Line 203

is just "o\bo".

see for example 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), or before "is always true" in ksh(1).

The same happens with .Pp just before .El, see bgpd.conf(5).

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

reported again by sthen@ Wed, 18 Jan 2012 02:09:39 +0000 (UTC)

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

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

Line 258

Line 229

.Bl -tag -width ".Dv message"

in magic(5), located in src/usr.bin/file, is the same

as -width 7n, not -width 11n.

The same applies to .Bl -column column widths;

reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar

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

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

Line 266

Line 239

- When .Fn arguments exceed one output line, all but the first

should be indented, see e.g. rpc(3);

reported by jmc@ on discuss@ Fri, 29 Oct 2010 13:48:33 +0100

reported again by Nicolas Joly via wiz@ Sun, 18 Sep 2011 18:24:40 +0200

Also, we don't want to break the line within the argument of:

.Fa "chtype tl"

- .Ns should work when called at the end of an input line, see

the following code in vi(1):

Line 282

Line 258

found while talking to Chris Bennett

- In man(7), the sequence

.HP

one line of regular text

.SH

should not produce two blank lines before the .SH,

see for example named-checkconf(8).

- In man(7), the sequence

.SH HEADER

.PP

Line 325

Line 294

in dig(1).

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

* error reporting issues

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

* performance issues

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

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

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

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

* structural issues

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

- We use the input line number at several places to distinguish

same-line from different-line input. That plainly doesn't work

with user-defined macros, leading to random breakage.

- Find better ways to prevent endless loops

in roff(7) macro and string expansion.

CVSweb