Annotation of mandoc/TODO, Revision 1.61
1.1 kristaps 1: ************************************************************************
1.37 kristaps 2: * Official mandoc TODO.
1.61 ! schwarze 3: * $Id: TODO,v 1.60 2010/10/17 21:10: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:
! 16: ************************************************************************
1.1 kristaps 17: * missing features
18: ************************************************************************
1.61 ! schwarze 19:
! 20: - deal with nested displays, e.g. D1 inside Bd
! 21: schwarze has an old patch somewhere and would need to brush it up
1.1 kristaps 22:
23: - explicit blocks with missing end macro should be implicitely closed
24: at the end of the enclosing block, e.g. .Bl It (El) Sh
25: reminded by stsp@ in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200
26:
1.18 schwarze 27: - fix bad block nesting involving multiple identical explicit blocks
28: see the OpenBSD mdoc_macro.c 1.47 commit message
29:
1.1 kristaps 30: - .Bl -column .Xo support is missing
31: ultimate goal:
32: restore .Xr and .Dv to
33: lib/libc/compat-43/sigvec.3
34: lib/libc/gen/signal.3
35: lib/libc/sys/sigaction.2
36:
1.28 schwarze 37: - edge case: decide how to deal with blk_full bad nesting, e.g.
38: .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
39: from jmc@ Wed, 14 Jul 2010 18:10:32 +0100
40:
41: - auto-Bk in the SYNOPSIS
42: patch from kristaps@ Fri, 16 Jul 2010 14:51:24 +0200
43: to be revisited after OpenBSD 4.8 tree unlock
44:
1.1 kristaps 45: - implement \\
46: in plain text, identical to \e
47: as a macro argument, identical to \ i.e. escaping the next character
48: We do not have macro definitions yet; if we implement them,
49: \\ must behave in a macro def like in a macro argument,
50: and when using the macro, it must expand yet again.
1.22 schwarze 51:
1.60 schwarze 52: - implement basic non-parametric .de to support e.g. sox(1)
53: .de SP
54: .if t .sp .5
55: .if n .sp
56: ..
57: .de EX
58: .SP
59: .nf
60: .ft CW
61: ..
62: .de EE
63: .ft R
64: .SP
65: .fi
66: ..
67: reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
68:
69: - port OpenBSD tbl integration bsd.lv, probably cleaning it up
1.1 kristaps 70:
71: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
72: These are a weird mixture of man(7) and custom autogenerated low-level
73: roff stuff. Figure out to what extent we can cope.
74: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
75: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
76:
1.10 kristaps 77: - implement blank `Bl -column', such as
78: .Bl -column
79: .It foo Ta bar
80: .El
1.11 kristaps 81:
82: - explicitly disallow nested `Bl -column', which would clobber internal
83: flags defined for struct mdoc_macro
1.42 schwarze 84:
85: - inside `.Bl -column' phrases, punctuation is handled like normal
86: text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
87:
88: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
89: is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
90: but should give "ab ."
1.12 kristaps 91:
92: - set a meaningful default if no `Bl' list type is assigned
1.13 kristaps 93:
94: - have a blank `It' head for `Bl -tag' not puke
1.20 kristaps 95:
96: - prohibit `Nm' from having non-text HEAD children
97: (e.g., NetBSD mDNSShared/dns-sd.1)
98: (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.36 kristaps 99:
100: - allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments
101: noted by Alex Kozlov 08/06/10 23:05
1.57 kristaps 102:
103: - Have `Sh', `It', `Ss' and others complain if `Pp' is invoked prior to
104: close (in the post validation) or prior to open (pre). This noted by
105: jmc@ a thousand years ago.
1.41 kristaps 106:
1.1 kristaps 107: ************************************************************************
108: * formatting issues: ugly output
109: ************************************************************************
1.33 schwarze 110:
1.28 schwarze 111: - perl(1) SYNOPSIS looks bad; reported by deraadt@
1.29 kristaps 112: 1) man(7) seems to need SYNOPSIS .Nm blocks, too
1.1 kristaps 113:
1.39 schwarze 114: - In .Bl -column,
115: .It Em Authentication<tab>Key Length
116: ought to render "Key Length" with emphasis, too,
117: see OpenBSD iked.conf(5).
118:
1.1 kristaps 119: - empty phrases in .Bl column produce too few blanks
120: try e.g. .Bl -column It Ta Ta
121: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.48 schwarze 122:
123: - in enclosures, mandoc sometimes fancies a bogus end of sentence
124: reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059
1.35 kristaps 125:
1.1 kristaps 126: ************************************************************************
127: * formatting issues: gratuitious differences
128: ************************************************************************
129:
1.38 schwarze 130: - .%T should be quoted, not underlined, when .%J is also present,
131: to better distinguish the contents of .%T and .%J,
132: see for example OpenBSD cat(1)
133:
134: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
135: is just "o\bo".
136: see for example OpenBSD ksh(1)
137:
138: - The characters "|" and "\*(Ba" should never be bold,
139: not even in the middle of a word, e.g. ".Cm b\*(Bac" in
140: "mknod [-m mode] name b|c major minor"
141: in OpenBSD ksh(1)
142:
143: - A bogus .Pp between two .It must not produce a double blank line,
1.39 schwarze 144: see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
145: or in DIAGNOSTICS in init(8).
146:
147: - .Bd -literal and .Bd -unfilled are *not* identical.
148: In -literal, tabs are 8 spaces.
149: In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.
150: See the CCDF_* display in OpenBSD ccdconfig(8).
151:
152: - .Nx 1.0a
153: should be "NetBSD 1.0A", not "NetBSD 1.0a",
154: see OpenBSD ccdconfig(8).
155:
156: - In .Bl -tag, if a tag exceeds the right margin and must be continued
157: on the next line, it must be indented by -width, not width+1;
158: see "rule block|pass" in OpenBSD ifconfig(8).
1.56 schwarze 159:
160: - The \& zero-width character counts as output.
161: That is, when it is alone on a line between two .Pp,
162: we want three blank lines, not two as in mandoc.
1.1 kristaps 163:
1.9 kristaps 164: ************************************************************************
165: * performance issues
166: ************************************************************************
167:
168: Several areas can be cleaned up to make mandoc even faster. These are
169:
170: - improve hashing mechanism for macros (quite important: performance)
171:
172: - improve hashing mechanism for characters (not as important)
1.23 kristaps 173:
1.37 kristaps 174: - the PDF file is HUGE: this can be reduced by using relative offsets
175:
1.23 kristaps 176: ************************************************************************
177: * structural issues
178: ************************************************************************
CVSweb