Annotation of mandoc/TODO, Revision 1.40
1.1 kristaps 1: ************************************************************************
1.37 kristaps 2: * Official mandoc TODO.
1.40 ! kristaps 3: * $Id: TODO,v 1.39 2010/08/15 17:38:41 schwarze Exp $
1.27 kristaps 4: ************************************************************************
5:
6: ************************************************************************
1.1 kristaps 7: * missing features
8: ************************************************************************
9:
10: - explicit blocks with missing end macro should be implicitely closed
11: at the end of the enclosing block, e.g. .Bl It (El) Sh
12: reminded by stsp@ in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200
13:
1.18 schwarze 14: - fix bad block nesting involving multiple identical explicit blocks
15: see the OpenBSD mdoc_macro.c 1.47 commit message
16:
1.1 kristaps 17: - .Bl -column .Xo support is missing
18: ultimate goal:
19: restore .Xr and .Dv to
20: lib/libc/compat-43/sigvec.3
21: lib/libc/gen/signal.3
22: lib/libc/sys/sigaction.2
23:
1.28 schwarze 24: - edge case: decide how to deal with blk_full bad nesting, e.g.
25: .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
26: from jmc@ Wed, 14 Jul 2010 18:10:32 +0100
27:
28: - auto-Bk in the SYNOPSIS
29: patch from kristaps@ Fri, 16 Jul 2010 14:51:24 +0200
30: to be revisited after OpenBSD 4.8 tree unlock
31:
1.1 kristaps 32: - implement \\
33: in plain text, identical to \e
34: as a macro argument, identical to \ i.e. escaping the next character
35: We do not have macro definitions yet; if we implement them,
36: \\ must behave in a macro def like in a macro argument,
37: and when using the macro, it must expand yet again.
1.22 schwarze 38:
1.1 kristaps 39: - look at bsd.lv tbl(1)
40: from kristaps@ Fri, 11 Sep 2009 17:10:53 +0200
1.17 schwarze 41: also look at the mail from Thomas Klausner wiz at NetBSD
42: on Wed, 2 Jun 2010 11:01:29 +0200
1.35 kristaps 43: joerg@ has patches for this somewhere...
1.1 kristaps 44:
45: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
46: These are a weird mixture of man(7) and custom autogenerated low-level
47: roff stuff. Figure out to what extent we can cope.
48: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
49: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
50:
1.10 kristaps 51: - implement blank `Bl -column', such as
52: .Bl -column
53: .It foo Ta bar
54: .El
1.11 kristaps 55:
56: - explicitly disallow nested `Bl -column', which would clobber internal
57: flags defined for struct mdoc_macro
1.12 kristaps 58:
59: - set a meaningful default if no `Bl' list type is assigned
1.13 kristaps 60:
61: - have a blank `It' head for `Bl -tag' not puke
1.20 kristaps 62:
63: - prohibit `Nm' from having non-text HEAD children
64: (e.g., NetBSD mDNSShared/dns-sd.1)
65: (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.36 kristaps 66:
67: - allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments
68: noted by Alex Kozlov 08/06/10 23:05
1.10 kristaps 69:
1.1 kristaps 70: ************************************************************************
71: * formatting issues: ugly output
72: ************************************************************************
1.33 schwarze 73:
1.28 schwarze 74: - perl(1) SYNOPSIS looks bad; reported by deraadt@
1.29 kristaps 75: 1) man(7) seems to need SYNOPSIS .Nm blocks, too
1.1 kristaps 76:
1.39 schwarze 77: - In .Bl -column,
78: .It Em Authentication<tab>Key Length
79: ought to render "Key Length" with emphasis, too,
80: see OpenBSD iked.conf(5).
81:
1.1 kristaps 82: - empty phrases in .Bl column produce too few blanks
83: try e.g. .Bl -column It Ta Ta
84: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.35 kristaps 85:
86: - %A doesn't put an "and" before the final author name.
1.1 kristaps 87:
88: ************************************************************************
89: * formatting issues: gratuitious differences
90: ************************************************************************
91:
1.38 schwarze 92: - .%T should be quoted, not underlined, when .%J is also present,
93: to better distinguish the contents of .%T and .%J,
94: see for example OpenBSD cat(1)
95:
96: - .It ${name Ns [ selector ] Ns }
97: should be "${name[selector]}" not "${name [selector]}"
98: This is parsed as
99: text("${name") text("[") Ns() text(selector)...
100: Opening punctuation should not fall out of .Ns.
101: see for example OpenBSD csh(1)
102:
103: - .%A should append the last author with " and " (if there are two)
104: or ", and " (if there are more), not ", "
105: see for example OpenBSD csh(1)
106:
107: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
108: is just "o\bo".
109: see for example OpenBSD ksh(1)
110:
111: - .No text No ) is "text )", not "text)"
112: see the terrible example
113: case word in [[(] pattern [| pattern] ... ) list ;; ] ... esac
114: in OpenBSD ksh(1)
115:
116: - .Sm should *not* produce as a blank line in .Bd -literal
117: see for example "Brace expansion" in OpenBSD ksh(1)
118:
119: - The characters "|" and "\*(Ba" should never be bold,
120: not even in the middle of a word, e.g. ".Cm b\*(Bac" in
121: "mknod [-m mode] name b|c major minor"
122: in OpenBSD ksh(1)
123:
124: - A bogus .Pp between two .It must not produce a double blank line,
1.39 schwarze 125: see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
126: or in DIAGNOSTICS in init(8).
127:
128: - .Bd -literal and .Bd -unfilled are *not* identical.
129: In -literal, tabs are 8 spaces.
130: In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.
131: See the CCDF_* display in OpenBSD ccdconfig(8).
132:
133: - In .Bd -unfilled, .Pp should produce one blank line, not two;
134: see the ccd.conf display in OpenBSD ccdconfig(8).
135:
136: - .Nx 1.0a
137: should be "NetBSD 1.0A", not "NetBSD 1.0a",
138: see OpenBSD ccdconfig(8).
139:
140: - In .Bl -tag, if a tag exceeds the right margin and must be continued
141: on the next line, it must be indented by -width, not width+1;
142: see "rule block|pass" in OpenBSD ifconfig(8).
143:
144: - When .%T is used outside an .Rs context and with a trailing comma,
145: there is no point in rendering two commata,
146: see the first paragraph of the DESCRIPTION in OpenBSD mount_nfs(8).
147:
148: - When .%T is used outside an .Rs context and without a trailing comma,
149: no comma should be rendered at all,
150: see the first paragraph of the DESCRIPTION in OpenBSD exports(5).
151:
152: - Bogus .Pp before .Bl should not cause a double blank line,
153: see "The route utility provides the following simple commands:"
154: in OpenBSD route(8).
1.1 kristaps 155:
1.9 kristaps 156: ************************************************************************
157: * performance issues
158: ************************************************************************
159:
160: Several areas can be cleaned up to make mandoc even faster. These are
161:
162: - improve hashing mechanism for macros (quite important: performance)
163:
164: - improve hashing mechanism for characters (not as important)
1.23 kristaps 165:
1.37 kristaps 166: - the PDF file is HUGE: this can be reduced by using relative offsets
167:
1.23 kristaps 168: ************************************************************************
169: * structural issues
170: ************************************************************************
1.33 schwarze 171:
172: - rendering frontend code can calculate widths only for plain strings,
173: not for strings containing escape sequences. For example, this
174: hinders calculation of the indent required for .Nm \&[ in text(1).
175: comments from kristaps@ Wed, 21 Jul 2010 23:26:08 +0200
1.38 schwarze 176:
177: - another example of the same problem:
178: .Bl -tag -width "\eD{format}XX" -compact
179: in OpenBSD ksh(1) gives the wrong width
180: because "\e" is one character in groff, two in mandoc
181:
1.40 ! kristaps 182: - Now that `ds' is minimally supported, we can get rid of some
! 183: predefined strings. \*(C+ has already been thrown out. Track these
! 184: down and whack them. Look in e.g. gcc.1 for the top-level `ds'
! 185: invocations. These are reproduced across most crappy GNU manuals.
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