=================================================================== RCS file: /cvs/mandoc/TODO,v retrieving revision 1.82 retrieving revision 1.93 diff -u -p -r1.82 -r1.93 --- mandoc/TODO 2011/01/23 15:35:10 1.82 +++ mandoc/TODO 2011/03/19 23:36:08 1.93 @@ -1,6 +1,6 @@ ************************************************************************ * Official mandoc TODO. -* $Id: TODO,v 1.82 2011/01/23 15:35:10 schwarze Exp $ +* $Id: TODO,v 1.93 2011/03/19 23:36:08 schwarze Exp $ ************************************************************************ ************************************************************************ @@ -49,6 +49,8 @@ - pod2man expects `tr' to be implemented for \*(-- to work +- \c (interrupted text) occurs in chat(8) + --- missing mdoc features ---------------------------------------------- - fix bad block nesting involving multiple identical explicit blocks @@ -125,6 +127,14 @@ see textproc/mgdiff(1) for nice examples (3) undefined, just output the character -> perhaps WARNING +- The \t escape sequence is the same as a literal tab, see for example + the ASCII table in hexdump(1) where + .Bl -column \&000_nu \&001_so \&002_st \&003_et \&004_eo + .It \&000\ nul\t001\ soh\t002\ stx\t003\ etx\t004\ eot\t005\ enq + produces + 000 nul 001 soh 002 stx 003 etx 004 eot 005 enq + and the example in oldrdist(1) + - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1) These are a weird mixture of man(7) and custom autogenerated low-level roff stuff. Figure out to what extent we can cope. @@ -141,6 +151,9 @@ * formatting issues: ugly output ************************************************************************ +- a column list with blank `Ta' cells triggers a spurrious + start-with-whitespace printing of a newline + - double quotes inside double quotes are escaped by doubling them implement this in mdoc(7), too so far, we only have it in roff(7) and man(7) @@ -158,6 +171,15 @@ try e.g. .Bl -column It Ta Ta reported by millert Fri, 02 Apr 2010 16:13:46 -0400 +- .%T can have trailing punctuation. Currently, it puts the trailing + punctuation into a trailing MDOC_TEXT element inside its own scope. + That element should rather be outside its scope, such that the + punctuation does not get underlines. This is not trivial to + implement because .%T then needs some features of in_line_eoln() - + slurp all arguments into one single text element - and one feature + of in_line() - put trailing punctuation out of scope. + Found in mount_nfs(8) and exports(5), search for "Appendix". + - in enclosures, mandoc sometimes fancies a bogus end of sentence reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059 @@ -180,10 +202,19 @@ - A bogus .Pp between two .It must not produce a double blank line, see between -R and -r in OpenBSD rm(1), before "update" in mount(8), - or in DIAGNOSTICS in init(8). + or in DIAGNOSTICS in init(8), or before "is always true" in ksh(1). + The same happens with .Pp just before .El, see bgpd.conf(5). Also have `It' complain if `Pp' is invoked at certain times (not -compact?). +- If the *first* line after .It is .Pp, break the line right after + the tag, do not pad with space characters before breaking. + See the description of the a, c, and i commands in sed(1). + +- If the first line after .It is .D1, do not assert a blank line + in between, see for example tmux(1). + reported by nicm@ 13 Jan 2011 00:18:57 +0000 + - .Nx 1.0a should be "NetBSD 1.0A", not "NetBSD 1.0a", see OpenBSD ccdconfig(8). @@ -192,6 +223,12 @@ on the next line, it must be indented by -width, not width+1; see "rule block|pass" in OpenBSD ifconfig(8). +- When the -width string contains macros, the macros must be rendered + before measuring the width, for example + .Bl -tag -width ".Dv message" + in magic(5), located in src/usr.bin/file, is the same + as -width 7n, not -width 11n. + - The \& zero-width character counts as output. That is, when it is alone on a line between two .Pp, we want three blank lines, not two as in mandoc. @@ -200,15 +237,51 @@ should be indented, see e.g. rpc(3); reported by jmc@ on discuss@ Fri, 29 Oct 2010 13:48:33 +0100 +- .Ns should work when called at the end of an input line, see + the following code in vi(1): + .It Xo + .Op Ar line + .Cm a Ns Op Cm ppend Ns + .Op Cm !\& + .Xc + The input text is appended after the specified line. + - Header lines of excessive length: Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c and document it in mdoc(7) and man(7) COMPATIBILITY found while talking to Chris Bennett +- In man(7), the sequence + .HP + one line of regular text + .SH + should not produce two blank lines before the .SH, + see for example named-checkconf(8). + +- In man(7), the sequence + regular text + .RS + .IP + should have a blank line between the text and the beginning of the + indented paragraph, see for example sudo(1). + +- At least sometimes, .sp is ignored right after .SH; see named.conf(5). + +- trailing whitespace must be ignored even when followed by a font escape, + see for example + makes + \fBdig \fR + operate in batch mode + in dig(1). + ************************************************************************ * error reporting issues ************************************************************************ +- empty .RS blocks in man(7) should be warnings, not errors, + see for example qemu(1); + brad@comstyle.com Sat Mar 19 00:36:56 2011 + ************************************************************************ * performance issues ************************************************************************ @@ -227,4 +300,12 @@ Several areas can be cleaned up to make mandoc even fa - Find better ways to prevent endless loops in roff(7) macro and string expansion. - + +- Clean up date handling. + Store dates as strings, not time numbers. + When the format is not recognized, just use the string from the input. + When the format is recognized, normalize the string to whatever + format is standard at the respective place. + Decide which formats should be recognized where. + Update both mdoc(7) and man(7) documentation. + Triggered by Tim van der Molen Tue, 22 Feb 2011 20:30:45 +0100