Annotation of mandoc/TODO, Revision 1.59
1.1 kristaps 1: ************************************************************************
1.37 kristaps 2: * Official mandoc TODO.
1.59 ! kristaps 3: * $Id: TODO,v 1.58 2010/10/01 21:51:13 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.42 schwarze 58:
59: - inside `.Bl -column' phrases, punctuation is handled like normal
60: text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
61:
62: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
63: is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
64: but should give "ab ."
1.12 kristaps 65:
66: - set a meaningful default if no `Bl' list type is assigned
1.13 kristaps 67:
68: - have a blank `It' head for `Bl -tag' not puke
1.20 kristaps 69:
70: - prohibit `Nm' from having non-text HEAD children
71: (e.g., NetBSD mDNSShared/dns-sd.1)
72: (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.36 kristaps 73:
74: - allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments
75: noted by Alex Kozlov 08/06/10 23:05
1.57 kristaps 76:
77: - Have `Sh', `It', `Ss' and others complain if `Pp' is invoked prior to
78: close (in the post validation) or prior to open (pre). This noted by
79: jmc@ a thousand years ago.
1.41 kristaps 80:
1.1 kristaps 81: ************************************************************************
82: * formatting issues: ugly output
83: ************************************************************************
1.33 schwarze 84:
1.28 schwarze 85: - perl(1) SYNOPSIS looks bad; reported by deraadt@
1.29 kristaps 86: 1) man(7) seems to need SYNOPSIS .Nm blocks, too
1.1 kristaps 87:
1.39 schwarze 88: - In .Bl -column,
89: .It Em Authentication<tab>Key Length
90: ought to render "Key Length" with emphasis, too,
91: see OpenBSD iked.conf(5).
92:
1.1 kristaps 93: - empty phrases in .Bl column produce too few blanks
94: try e.g. .Bl -column It Ta Ta
95: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.48 schwarze 96:
97: - in enclosures, mandoc sometimes fancies a bogus end of sentence
98: reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059
1.35 kristaps 99:
1.1 kristaps 100: ************************************************************************
101: * formatting issues: gratuitious differences
102: ************************************************************************
103:
1.38 schwarze 104: - .%T should be quoted, not underlined, when .%J is also present,
105: to better distinguish the contents of .%T and .%J,
106: see for example OpenBSD cat(1)
107:
108: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
109: is just "o\bo".
110: see for example OpenBSD ksh(1)
111:
112: - The characters "|" and "\*(Ba" should never be bold,
113: not even in the middle of a word, e.g. ".Cm b\*(Bac" in
114: "mknod [-m mode] name b|c major minor"
115: in OpenBSD ksh(1)
116:
117: - A bogus .Pp between two .It must not produce a double blank line,
1.39 schwarze 118: see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
119: or in DIAGNOSTICS in init(8).
120:
121: - .Bd -literal and .Bd -unfilled are *not* identical.
122: In -literal, tabs are 8 spaces.
123: In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.
124: See the CCDF_* display in OpenBSD ccdconfig(8).
125:
126: - .Nx 1.0a
127: should be "NetBSD 1.0A", not "NetBSD 1.0a",
128: see OpenBSD ccdconfig(8).
129:
130: - In .Bl -tag, if a tag exceeds the right margin and must be continued
131: on the next line, it must be indented by -width, not width+1;
132: see "rule block|pass" in OpenBSD ifconfig(8).
1.56 schwarze 133:
134: - The \& zero-width character counts as output.
135: That is, when it is alone on a line between two .Pp,
136: we want three blank lines, not two as in mandoc.
1.1 kristaps 137:
1.9 kristaps 138: ************************************************************************
139: * performance issues
140: ************************************************************************
141:
142: Several areas can be cleaned up to make mandoc even faster. These are
143:
144: - improve hashing mechanism for macros (quite important: performance)
145:
146: - improve hashing mechanism for characters (not as important)
1.23 kristaps 147:
1.37 kristaps 148: - the PDF file is HUGE: this can be reduced by using relative offsets
149:
1.23 kristaps 150: ************************************************************************
151: * structural issues
152: ************************************************************************
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