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