Annotation of mandoc/TODO, Revision 1.41
1.1 kristaps 1: ************************************************************************
1.37 kristaps 2: * Official mandoc TODO.
1.41 ! kristaps 3: * $Id: TODO,v 1.40 2010/08/16 09:51:17 kristaps 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.41 ! kristaps 69:
! 70: - 'br\} doesn't correctly close scope.
! 71: Noted by joerg@, 28/7/2010.
1.10 kristaps 72:
1.1 kristaps 73: ************************************************************************
74: * formatting issues: ugly output
75: ************************************************************************
1.33 schwarze 76:
1.28 schwarze 77: - perl(1) SYNOPSIS looks bad; reported by deraadt@
1.29 kristaps 78: 1) man(7) seems to need SYNOPSIS .Nm blocks, too
1.1 kristaps 79:
1.39 schwarze 80: - In .Bl -column,
81: .It Em Authentication<tab>Key Length
82: ought to render "Key Length" with emphasis, too,
83: see OpenBSD iked.conf(5).
84:
1.1 kristaps 85: - empty phrases in .Bl column produce too few blanks
86: try e.g. .Bl -column It Ta Ta
87: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.35 kristaps 88:
89: - %A doesn't put an "and" before the final author name.
1.1 kristaps 90:
91: ************************************************************************
92: * formatting issues: gratuitious differences
93: ************************************************************************
94:
1.38 schwarze 95: - .%T should be quoted, not underlined, when .%J is also present,
96: to better distinguish the contents of .%T and .%J,
97: see for example OpenBSD cat(1)
98:
99: - .It ${name Ns [ selector ] Ns }
100: should be "${name[selector]}" not "${name [selector]}"
101: This is parsed as
102: text("${name") text("[") Ns() text(selector)...
103: Opening punctuation should not fall out of .Ns.
104: see for example OpenBSD csh(1)
105:
106: - .%A should append the last author with " and " (if there are two)
107: or ", and " (if there are more), not ", "
108: see for example OpenBSD csh(1)
109:
110: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
111: is just "o\bo".
112: see for example OpenBSD ksh(1)
113:
114: - .No text No ) is "text )", not "text)"
115: see the terrible example
116: case word in [[(] pattern [| pattern] ... ) list ;; ] ... esac
117: in OpenBSD ksh(1)
118:
119: - .Sm should *not* produce as a blank line in .Bd -literal
120: see for example "Brace expansion" in OpenBSD ksh(1)
121:
122: - The characters "|" and "\*(Ba" should never be bold,
123: not even in the middle of a word, e.g. ".Cm b\*(Bac" in
124: "mknod [-m mode] name b|c major minor"
125: in OpenBSD ksh(1)
126:
127: - A bogus .Pp between two .It must not produce a double blank line,
1.39 schwarze 128: see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
129: or in DIAGNOSTICS in init(8).
130:
131: - .Bd -literal and .Bd -unfilled are *not* identical.
132: In -literal, tabs are 8 spaces.
133: In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.
134: See the CCDF_* display in OpenBSD ccdconfig(8).
135:
136: - In .Bd -unfilled, .Pp should produce one blank line, not two;
137: see the ccd.conf display in OpenBSD ccdconfig(8).
138:
139: - .Nx 1.0a
140: should be "NetBSD 1.0A", not "NetBSD 1.0a",
141: see OpenBSD ccdconfig(8).
142:
143: - In .Bl -tag, if a tag exceeds the right margin and must be continued
144: on the next line, it must be indented by -width, not width+1;
145: see "rule block|pass" in OpenBSD ifconfig(8).
146:
147: - When .%T is used outside an .Rs context and with a trailing comma,
148: there is no point in rendering two commata,
149: see the first paragraph of the DESCRIPTION in OpenBSD mount_nfs(8).
150:
151: - When .%T is used outside an .Rs context and without a trailing comma,
152: no comma should be rendered at all,
153: see the first paragraph of the DESCRIPTION in OpenBSD exports(5).
154:
155: - Bogus .Pp before .Bl should not cause a double blank line,
156: see "The route utility provides the following simple commands:"
157: in OpenBSD route(8).
1.1 kristaps 158:
1.9 kristaps 159: ************************************************************************
160: * performance issues
161: ************************************************************************
162:
163: Several areas can be cleaned up to make mandoc even faster. These are
164:
165: - improve hashing mechanism for macros (quite important: performance)
166:
167: - improve hashing mechanism for characters (not as important)
1.23 kristaps 168:
1.37 kristaps 169: - the PDF file is HUGE: this can be reduced by using relative offsets
170:
1.23 kristaps 171: ************************************************************************
172: * structural issues
173: ************************************************************************
1.33 schwarze 174:
175: - rendering frontend code can calculate widths only for plain strings,
176: not for strings containing escape sequences. For example, this
177: hinders calculation of the indent required for .Nm \&[ in text(1).
178: comments from kristaps@ Wed, 21 Jul 2010 23:26:08 +0200
1.38 schwarze 179:
180: - another example of the same problem:
181: .Bl -tag -width "\eD{format}XX" -compact
182: in OpenBSD ksh(1) gives the wrong width
183: because "\e" is one character in groff, two in mandoc
184:
1.40 kristaps 185: - Now that `ds' is minimally supported, we can get rid of some
186: predefined strings. \*(C+ has already been thrown out. Track these
187: down and whack them. Look in e.g. gcc.1 for the top-level `ds'
188: 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