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