Annotation of mandoc/TODO, Revision 1.10
1.1 kristaps 1: ************************************************************************
2: * missing features
3: ************************************************************************
4:
5: - explicit blocks with missing end macro should be implicitely closed
6: at the end of the enclosing block, e.g. .Bl It (El) Sh
7: reminded by stsp@ in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200
8:
9: - .Bl -column .Xo support is missing
10: ultimate goal:
11: restore .Xr and .Dv to
12: lib/libc/compat-43/sigvec.3
13: lib/libc/gen/signal.3
14: lib/libc/sys/sigaction.2
15:
16: - .Bk / .Ek is broken, e.g.
17: $ man ssh
18: [...]
19: ssh [-1246AaCfgKkMNnqsTtVvXxYy] [-b bind_address] [-c cipher_spec] [-D
20: [bind_address:]port] [-e escape_char] [-F configfile] [-I pkcs11]
21: reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200
22: also reported by jmc@ earlier
23:
24: - implement \\
25: in plain text, identical to \e
26: as a macro argument, identical to \ i.e. escaping the next character
27: We do not have macro definitions yet; if we implement them,
28: \\ must behave in a macro def like in a macro argument,
29: and when using the macro, it must expand yet again.
30:
31: - look at bsd.lv tbl(1)
32: from kristaps@ Fri, 11 Sep 2009 17:10:53 +0200
33:
34: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
35: These are a weird mixture of man(7) and custom autogenerated low-level
36: roff stuff. Figure out to what extent we can cope.
37: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
38: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
39:
40:
41: - FIXED OpenBSD term.h 1.16 term.c 1.30 mdoc_term.c 1.75 schwarze 23.4.10
42: handle tab characters outside literal context, e.g. usb(4)
43: reported by jmc@ Mon, 19 Apr 2010 07:42:12 +0100
1.2 schwarze 44: NEEDS MERGING TO bsd.lv
1.1 kristaps 45:
46: - FIXED OpenBSD man.h 1.15 libman.h 1.16 man_hash.c 1.9
47: man.c 1.25 man_macro.c 1.15 man_validate.c 1.19 man_action.c 1.15
48: man_term.c 1.28 man_html.c 1.9 schwarze 25.4.
49: implement .if .ie .el
50: noticed by espie@ Fri, 23 Apr 2010 17:10:35 +0200
1.2 schwarze 51: NEEDS MERGING TO bsd.lv
1.1 kristaps 52:
1.10 ! kristaps 53: - implement blank `Bl -column', such as
! 54: .Bl -column
! 55: .It foo Ta bar
! 56: .El
! 57:
1.1 kristaps 58: ************************************************************************
59: * formatting issues: ugly output
60: ************************************************************************
61:
62: - outside list context, text following .Sm off
63: seems to follow without a blank (TERM_NOBLANK reset late?) e.g.
64: .Sm off
65: .Xo
66: .Op Ar bind_address No /
67: .Ar port
68: .Xc
69: .Sm on
70: or by enclosing
71: reported by jmc Tue, 13 Apr 2010 08:48:14 +0100
72:
73: - do not break the line after "--", it's probably a long option
74: reminded by stsp in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200
75:
76: - URGENT, this is making many kernel manuals look bad:
77: .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?
78: autoconf.9:
79: .Sh DIRECT CONFIGURATION
80: .nr nS 1
81: .Ft "struct device *"
82: .Fn config_found_sm "struct device *parent"
83: groff:
84: DIRECT CONFIGURATION
85: struct device *
86: config_found_sm(struct device *parent, ...
87: reported by sthen Tue, 20 Apr 2010 13:42:51 +0100
88:
89: - indentation got lost in SYNOPSIS, e.g.
90: SYNOPSIS
91: date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format]
92: - [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
93: + [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
94: reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200
95:
96: - empty phrases in .Bl column produce too few blanks
97: try e.g. .Bl -column It Ta Ta
98: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
99:
1.5 joerg 100: - nroff inserts a space before :, mandoc doesn't:
101: .Dl expr "/$a" Li : '.*/\e(.*\e)'
1.1 kristaps 102:
103: ************************************************************************
104: * formatting issues: gratuitious differences
105: ************************************************************************
106:
1.7 schwarze 107: - FIXED OpenBSD mdoc.c 1.52 schwarze 16.5.10
108: lines containing blank characters, and nothing else,
1.1 kristaps 109: in literal context (.Bd -literal):
110: groff outputs just blank lines "\n"
111: mandoc outputs blanks to the left margin,
112: then the number of balnks minus one
1.7 schwarze 113: NEEDS MERGING TO bsd.lv
1.1 kristaps 114:
115:
116: ************************************************************************
117: * parser errors without any effect on formatting
118: ************************************************************************
119:
120: - OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree
121:
1.9 kristaps 122: ************************************************************************
123: * performance issues
124: ************************************************************************
125:
126: Several areas can be cleaned up to make mandoc even faster. These are
127:
128: - cache `Bd' display types as `Bl' types are cached (this primarily
129: improves code-size by removing the a2disp type functions)
130:
131: - improve caching mechanism to handle other per-element arguments so
132: that they need not be recalculated between front- and back-ends (also
133: reduces code size and complexity)
134:
135: - improve hashing mechanism for macros (quite important: performance)
136:
137: - improve hashing mechanism for characters (not as important)
CVSweb