Annotation of mandoc/TODO, Revision 1.80
1.1 kristaps 1: ************************************************************************
1.37 kristaps 2: * Official mandoc TODO.
1.80 ! schwarze 3: * $Id: TODO,v 1.79 2011/01/22 20:24:53 schwarze Exp $
1.27 kristaps 4: ************************************************************************
5:
6: ************************************************************************
1.61 schwarze 7: * parser bugs
8: ************************************************************************
9:
10: - the roff parser doesn't tolerate additional characters between
11: a macro and the \} terminating a conditional block, e.g.
12: .if n \{
13: .br \}
14: reported by ulrich spoerlein Tue, 19 Oct 2010 20:39:50 +0200
15:
1.74 schwarze 16: ************************************************************************
17: * formatter bugs
18: ************************************************************************
1.63 schwarze 19:
1.61 schwarze 20: ************************************************************************
1.1 kristaps 21: * missing features
22: ************************************************************************
1.70 kristaps 23:
1.79 schwarze 24: --- missing roff features ----------------------------------------------
25:
1.80 ! schwarze 26: - .ns (no-space mode) occurs in xine-config(1)
! 27: reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
1.61 schwarze 28:
1.80 ! schwarze 29: - xloadimage(1) wants .ti (temporary indent), rep by naddy@
1.75 schwarze 30:
1.80 ! schwarze 31: - pod2man expects `tr' to be implemented for \*(-- to work
1.79 schwarze 32:
33: --- missing mdoc features ----------------------------------------------
34:
1.18 schwarze 35: - fix bad block nesting involving multiple identical explicit blocks
36: see the OpenBSD mdoc_macro.c 1.47 commit message
37:
1.1 kristaps 38: - .Bl -column .Xo support is missing
39: ultimate goal:
40: restore .Xr and .Dv to
41: lib/libc/compat-43/sigvec.3
42: lib/libc/gen/signal.3
43: lib/libc/sys/sigaction.2
44:
1.28 schwarze 45: - edge case: decide how to deal with blk_full bad nesting, e.g.
46: .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
47: from jmc@ Wed, 14 Jul 2010 18:10:32 +0100
48:
1.74 schwarze 49: - \\ is now implemented correctly
50: * when defining strings and macros using .ds and .de
51: * when parsing roff(7) and man(7) macro arguments
52: It does not yet work in mdoc(7) macro arguments
53: because libmdoc does not yet use mandoc_getarg().
54: Also check what happens in plain text, it must be identical to \e.
1.22 schwarze 55:
1.10 kristaps 56: - implement blank `Bl -column', such as
57: .Bl -column
58: .It foo Ta bar
59: .El
1.11 kristaps 60:
61: - explicitly disallow nested `Bl -column', which would clobber internal
62: flags defined for struct mdoc_macro
1.42 schwarze 63:
64: - inside `.Bl -column' phrases, punctuation is handled like normal
65: text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
66:
67: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
68: is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
69: but should give "ab ."
1.12 kristaps 70:
71: - set a meaningful default if no `Bl' list type is assigned
1.13 kristaps 72:
73: - have a blank `It' head for `Bl -tag' not puke
1.20 kristaps 74:
75: - prohibit `Nm' from having non-text HEAD children
76: (e.g., NetBSD mDNSShared/dns-sd.1)
77: (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.57 kristaps 78:
1.79 schwarze 79: --- missing man features -----------------------------------------------
1.63 schwarze 80:
81: - bashbug(1) complains "line scope broken" after
82: .SM
83: .B something
84: should either just work or be a warning
85: reported by naddy@
1.79 schwarze 86:
1.80 ! schwarze 87: - groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
! 88: reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
! 89:
1.79 schwarze 90: --- missing tbl features -----------------------------------------------
91:
92: - implement basic non-parametric .de to support e.g. sox(1)
93: reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
94: *** sox(1) still doesn't work, tbl(1) errors need investigation
95:
96: --- missing misc features ----------------------------------------------
97:
98: - clean up escape sequence handling, creating three classes:
99: (1) fully implemented, or parsed and ignored without loss of content
100: (2) unimplemented, potentially causing loss of content
101: or serious mangling of formatting (e.g. \n) -> ERROR
102: see textproc/mgdiff(1) for nice examples
103: (3) undefined, just output the character -> perhaps WARNING
104:
105: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
106: These are a weird mixture of man(7) and custom autogenerated low-level
107: roff stuff. Figure out to what extent we can cope.
1.80 ! schwarze 108: For details, see http://docutils.sourceforge.net/rst.html
1.79 schwarze 109: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
110: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
1.71 schwarze 111:
112: - check compatibility with Plan9:
113: http://swtch.com/usr/local/plan9/tmac/tmac.an
114: http://swtch.com/plan9port/man/man7/man.html
115: "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63 schwarze 116:
1.1 kristaps 117: ************************************************************************
118: * formatting issues: ugly output
119: ************************************************************************
1.33 schwarze 120:
1.67 schwarze 121: - double quotes inside double quotes are escaped by doubling them
1.74 schwarze 122: implement this in mdoc(7), too
123: so far, we only have it in roff(7) and man(7)
1.67 schwarze 124: reminded by millert@ Thu, 09 Dec 2010 17:29:52 -0500
125:
1.28 schwarze 126: - perl(1) SYNOPSIS looks bad; reported by deraadt@
1.29 kristaps 127: 1) man(7) seems to need SYNOPSIS .Nm blocks, too
1.1 kristaps 128:
1.39 schwarze 129: - In .Bl -column,
130: .It Em Authentication<tab>Key Length
131: ought to render "Key Length" with emphasis, too,
132: see OpenBSD iked.conf(5).
133:
1.1 kristaps 134: - empty phrases in .Bl column produce too few blanks
135: try e.g. .Bl -column It Ta Ta
136: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.48 schwarze 137:
138: - in enclosures, mandoc sometimes fancies a bogus end of sentence
139: reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059
1.35 kristaps 140:
1.1 kristaps 141: ************************************************************************
142: * formatting issues: gratuitious differences
143: ************************************************************************
1.65 kristaps 144:
145: - .Rv (and probably .Ex) print different text if an `Nm' has been named
146: or not (run a manual without `Nm blah' to see this). I'm not sure
147: that this exists in the wild, but it's still an error.
1.38 schwarze 148:
149: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
150: is just "o\bo".
151: see for example OpenBSD ksh(1)
152:
153: - The characters "|" and "\*(Ba" should never be bold,
154: not even in the middle of a word, e.g. ".Cm b\*(Bac" in
155: "mknod [-m mode] name b|c major minor"
156: in OpenBSD ksh(1)
157:
158: - A bogus .Pp between two .It must not produce a double blank line,
1.39 schwarze 159: see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
160: or in DIAGNOSTICS in init(8).
1.68 kristaps 161: Also have `It' complain if `Pp' is invoked at certain times (not
162: -compact?).
1.39 schwarze 163:
164: - .Nx 1.0a
165: should be "NetBSD 1.0A", not "NetBSD 1.0a",
166: see OpenBSD ccdconfig(8).
167:
168: - In .Bl -tag, if a tag exceeds the right margin and must be continued
169: on the next line, it must be indented by -width, not width+1;
170: see "rule block|pass" in OpenBSD ifconfig(8).
1.56 schwarze 171:
172: - The \& zero-width character counts as output.
173: That is, when it is alone on a line between two .Pp,
174: we want three blank lines, not two as in mandoc.
1.63 schwarze 175:
176: - When .Fn arguments exceed one output line, all but the first
177: should be indented, see e.g. rpc(3);
178: reported by jmc@ on discuss@ Fri, 29 Oct 2010 13:48:33 +0100
1.64 schwarze 179:
180: - Header lines of excessive length:
181: Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
182: and document it in mdoc(7) and man(7) COMPATIBILITY
183: found while talking to Chris Bennett
1.75 schwarze 184:
185: ************************************************************************
186: * error reporting issues
187: ************************************************************************
1.1 kristaps 188:
1.9 kristaps 189: ************************************************************************
190: * performance issues
191: ************************************************************************
192:
193: Several areas can be cleaned up to make mandoc even faster. These are
194:
195: - improve hashing mechanism for macros (quite important: performance)
196:
197: - improve hashing mechanism for characters (not as important)
1.23 kristaps 198:
1.37 kristaps 199: - the PDF file is HUGE: this can be reduced by using relative offsets
200:
1.23 kristaps 201: ************************************************************************
202: * structural issues
203: ************************************************************************
1.67 schwarze 204:
205: - Find better ways to prevent endless loops
206: in roff(7) macro and string expansion.
207:
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to TODO CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc