mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.121 and 1.148

version 1.121, 2011/09/18 16:43:28

version 1.148, 2012/11/19 22:30:58

Line 4

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

* parser bugs

* crashes

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

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

None known right now.

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

also occurs in emulators/pcsxr/patches/patch-doc_pcsx_1

jeremy@ commit Wed, 7 Sep 2011 10:00:19 -0600 (MDT)

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

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

Line 37

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

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

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

even inside .Bd literal; that 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 ----------------------------------------------

- fix bad block nesting involving multiple identical explicit blocks

Line 131

Line 121

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

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

also occur in freeciv-client(6) freeciv-server(6) freeciv-modpack(6)

reported by bentley@ Tue, 30 Oct 2012 01:05:57 -0600

- -T[x]html doesn't stipulate non-collapsing spaces in literal mode

Line 185

Line 177

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 206

Line 196

of in_line() - put trailing punctuation out of scope.

Found in mount_nfs(8) and exports(5), search for "Appendix".

- Trailing punctuation after .%T triggers EOS spacing, at least

outside .Rs (eek!). Simply setting ARGSFL_DELIM for .%T is not

the right solution, it sends mandoc into an endless loop.

reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100

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

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

Line 221

Line 216

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 245

Line 229

in between, see for example tmux(1).

reported by nicm@ 13 Jan 2011 00:18:57 +0000

- Trailing punctuation after .It should trigger EOS spacing.

reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100

Probably, this should be fixed somewhere in termp_it_pre(), not sure.

- .Nx 1.0a

should be "NetBSD 1.0A", not "NetBSD 1.0a",

see OpenBSD ccdconfig(8).

Line 258

Line 246

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

Line 260

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

.It Xo

.Op Ar line

.Cm a Ns Op Cm ppend Ns

.Op Cm !\&

.Xc

The input text is appended after the specified line.

- Header lines of excessive length:

Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c

and document it in mdoc(7) and man(7) COMPATIBILITY

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

regular text

should not produce any blank lines between the header and the text,

see for example rsync(1).

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

- In man(7), the sequence

regular text

.IP

.IP "tag"

indented text

should produce one, not four blank lines between the regular text

and the tag, see for example rsync(1).

Likewise,

regular text

.IP

indented text

should produce one, not two blank lines in between, and

regular text

.IP

.RS

.IP tag

indented text

should produce one, not three blank lines.

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

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

see for example

makes

Line 328

Line 273

in dig(1).

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

* error reporting issues

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

* performance issues

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

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

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