Annotation of mandoc/TODO, Revision 1.16
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:
1.10 kristaps 40: - implement blank `Bl -column', such as
41: .Bl -column
42: .It foo Ta bar
43: .El
1.11 kristaps 44:
45: - explicitly disallow nested `Bl -column', which would clobber internal
46: flags defined for struct mdoc_macro
1.12 kristaps 47:
48: - set a meaningful default if no `Bl' list type is assigned
1.13 kristaps 49:
50: - have a blank `It' head for `Bl -tag' not puke
1.15 kristaps 51:
52: - ignore horrendous m[] font colouring
53: reported by J.C. Roberts
1.10 kristaps 54:
1.1 kristaps 55: ************************************************************************
56: * formatting issues: ugly output
57: ************************************************************************
58:
59: - outside list context, text following .Sm off
60: seems to follow without a blank (TERM_NOBLANK reset late?) e.g.
61: .Sm off
62: .Xo
63: .Op Ar bind_address No /
64: .Ar port
65: .Xc
66: .Sm on
67: or by enclosing
68: reported by jmc Tue, 13 Apr 2010 08:48:14 +0100
69:
70: - URGENT, this is making many kernel manuals look bad:
71: .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?
72: autoconf.9:
73: .Sh DIRECT CONFIGURATION
74: .nr nS 1
75: .Ft "struct device *"
76: .Fn config_found_sm "struct device *parent"
77: groff:
78: DIRECT CONFIGURATION
79: struct device *
80: config_found_sm(struct device *parent, ...
81: reported by sthen Tue, 20 Apr 2010 13:42:51 +0100
82:
83: - indentation got lost in SYNOPSIS, e.g.
84: SYNOPSIS
85: date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format]
86: - [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
87: + [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
88: reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200
89:
90: - empty phrases in .Bl column produce too few blanks
91: try e.g. .Bl -column It Ta Ta
92: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
93:
94: ************************************************************************
95: * formatting issues: gratuitious differences
96: ************************************************************************
97:
1.7 schwarze 98: - FIXED OpenBSD mdoc.c 1.52 schwarze 16.5.10
99: lines containing blank characters, and nothing else,
1.1 kristaps 100: in literal context (.Bd -literal):
101: groff outputs just blank lines "\n"
102: mandoc outputs blanks to the left margin,
103: then the number of balnks minus one
1.7 schwarze 104: NEEDS MERGING TO bsd.lv
1.1 kristaps 105:
106:
107: ************************************************************************
108: * parser errors without any effect on formatting
109: ************************************************************************
110:
111: - OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree
112:
1.9 kristaps 113: ************************************************************************
114: * performance issues
115: ************************************************************************
116:
117: Several areas can be cleaned up to make mandoc even faster. These are
118:
119: - improve caching mechanism to handle other per-element arguments so
120: that they need not be recalculated between front- and back-ends (also
1.16 ! kristaps 121: reduces code size and complexity):
! 122: `Bl -column' pointer
! 123: `Bf' font type
1.9 kristaps 124:
125: - improve hashing mechanism for macros (quite important: performance)
126:
127: - improve hashing mechanism for characters (not as important)
CVSweb