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