mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.231 and 1.240

version 1.231, 2017/02/05 20:22:04

version 1.240, 2017/07/19 21:48:37

Line 61 are mere guesses, and some may be wrong.

reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500

loc *** exist *** algo *** size ** imp *

- .ta (tab settings)

#1 most important issue naddy@ Mon, 16 Feb 2015 20:59:17 +0100

ircbug(1) gnats(1) reported by brad@ Sat, 15 Jan 2011 15:50:51 -0500

also Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100

also posix2time(3) Carsten Kunze Mon, 1 Dec 2014 13:03:10 +0100

loc ** exist *** algo ** size ** imp ***

- .ti (temporary indent)

found by naddy@ in xloadimage(1) [devel/libvstr] vstr(3)

found by bentley@ in nmh(1) Mon, 23 Apr 2012 13:38:28 -0600

loc ** exist ** algo ** size * imp ** (parser reorg helps a lot)

- .while and .shift

found by jca@ in ratpoison(1) Sun, 30 Jun 2013 12:01:09 +0200

loc * exist ** algo ** size ** imp **

- \h horizontal move

#2 most important issue naddy@ Mon, 16 Feb 2015 20:59:17 +0100

found in cclive(1) nasm(1) bogofilter(1) asciidoc/DocBook output

bentley@ on discuss@ Sat, 21 Sep 2013 22:29:34 -0600

naddy@ Thu, 4 Dec 2014 16:26:41 +0100

loc ** exist ** algo ** size * imp *** (parser reorg helps a lot)

- \n+ and \n- numerical register increment and decrement

found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700

loc * exist * algo * size * imp **

- \n(.$ macro argument count number register; ocserv(8) by autogen

found by sthen@ Thu, 19 Feb 2015 22:03:01 +0000

loc * exist ** algo * size * imp **

- \w'' improve width measurements

would not be very useful without an expression parser, see below

needed for Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100

Line 195 are mere guesses, and some may be wrong.

Line 172 are mere guesses, and some may be wrong.

--- missing tbl features -----------------------------------------------

- horizontal lines in the layout still consume data cells

and can be mixed with actual data on the same table line

synaptics(4) found by tedu@ Mon, 17 Aug 2015 21:17:42 -0400

loc ** exist ** algo ** size ** imp ***

- break long text into lines inside cells

net/lftp(1) from jirib via bentley@ Sep 13, 2016

- layout l1 for a column of max text width 3 reduces the following

inter-column spacing for groff, but not for mandoc

net/lftp(1) from jirib via bentley@ Sep 13, 2016

- the "w" layout option is ignored

synaptics(4) found by tedu@ Mon, 17 Aug 2015 21:17:42 -0400

loc * exist * algo * size * imp **

- the "s" layout column specifier is used for placement of data

into columns, but ignored during column width calculations

synaptics(4) found by tedu@ Mon, 17 Aug 2015 21:17:42 -0400

Line 219 are mere guesses, and some may be wrong.

Line 180 are mere guesses, and some may be wrong.

- support mdoc(7) and man(7) macros inside tbl(7) code;

probably requires the parser reorg and letting tbl(7)

use roff_node such that macro sets can mix;

informed by bapt@ that FreeBSD needs this.

informed by bapt@ that FreeBSD needs this: 3 Jan 2015 23:32:23 +0100

loc *** exist ** algo *** size ** imp ***

- look at the POSIX manuals in the books/man-pages-posix port,

Line 252 are mere guesses, and some may be wrong.

Line 213 are mere guesses, and some may be wrong.

see User's Guide (Second Edition) page 5 section 15.

loc ** exist ** algo ** size ** imp **

- GNU eqn converts some operators to special characters, for example,

input HYPHEN-MINUS becomes output \(mi, unless it is part of a

quoted word. mandoc(1) only does this when the operator is

surrounded by blanks, not when it is part of an unquoted word.

Also, check whether there are more such cases (e.g., +?).

reported by bentley@ 20 Jun 2017 02:04:29 -0600

- Primes, opprime, and '

bentley@ Thu, 13 Jul 2017 23:14:20 -0600

--- missing misc features ----------------------------------------------

- italic correction (\/) in PostScript mode

Line 273 are mere guesses, and some may be wrong.

Line 244 are mere guesses, and some may be wrong.

- kettenis wants base roff, ms, and me Fri, 1 Jan 2010 22:13:15 +0100 (CET)

loc ** exist ** algo ** size *** imp *

- Vsevolod Stakhov (FreeBSD) needs either a markdown output formatter

for mandoc -mdoc or a markdown to mdoc converter because they

have to maintain manuals needed both in markdown and mdoc format.

Look at the libsoldout (markdown -> whatever)

loc * exist * algo * size ** imp **

--- compatibility checks -----------------------------------------------

- is .Bk implemented correctly in modern groff?

Line 377 are mere guesses, and some may be wrong.

Line 342 are mere guesses, and some may be wrong.

.Vt vs .Vt/.Va vs .Ft/.Va vs .Ft/.Fa ...

from kristaps@ Tue, 08 Jun 2010 11:13:32 +0200

- implicit whitespace around inline equations

example code: where '$times$' denotes matrix multiplication

must not have an HTML line break, nor a blank, before <math>

partial solution: html.c {"math", HTML_NLINSIDE | HTML_INDENT},

bentley@ Thu, 13 Jul 2017 19:00:59 -0600

- in enclosures, mandoc sometimes fancies a bogus end of sentence

reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059

loc * exist ** algo *** size * imp ***

Line 385 are mere guesses, and some may be wrong.

Line 356 are mere guesses, and some may be wrong.

and triggers a line break; found in audio/normalize-mp3(1)

loc ** exist * algo ** size * imp **

- rendering of double quotes in -Tascii is ugly in both groff and mandoc

to improve, both would have to be changed

Carsten Kunze Fri, 12 Dec 2014 14:27:56 +0100

- formatting /usr/local/man/man1/latex2man.1 with groff and mandoc

reveals lots of bugs both in groff and mandoc...

reported by bentley@ Wed, 22 May 2013 23:49:30 -0600

Line 443 are mere guesses, and some may be wrong.

Line 410 are mere guesses, and some may be wrong.

Steffen Nurpmeso Sat, 08 Nov 2014 13:34:59 +0100

loc * exist ** algo ** size * imp **

- .Lk formatting for long links with line breaks

Franco Fichtner 8 Oct 2013 00:33:42 +0200

- In .Bl -enum -width 0n, groff continues one the same line after

the number, mandoc breaks the line.

mail to kristaps@ Mon, 20 Jul 2009 02:21:39 +0200

Line 490 are mere guesses, and some may be wrong.

Line 454 are mere guesses, and some may be wrong.

The same applies to .Bl -column column widths;

reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar

reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200

reported again by Bruce Evans Fri, 17 Feb 2017 21:22:44 +0100 via bapt@

loc *** exist *** algo *** size ** imp ***

An easy partial fix would be to just skip the first word if it starts

with a dot, including any following white space, when measuring.

Line 500 are mere guesses, and some may be wrong.

Line 465 are mere guesses, and some may be wrong.

we want three blank lines, not two as in mandoc.

loc ** exist ** algo ** size * imp **

- 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

loc * exist * algo * size * imp *

- Sequences of multiple man(7) paragraphs (.PP, .IP) interspersed

with .ps and .nf/.fi produce execessive blank lines, see libJudy

and graphics/dcmtk. The parser reorg may help with this.

Line 522 are mere guesses, and some may be wrong.

Line 481 are mere guesses, and some may be wrong.

* warning issues

************************************************************************

- provide a way in mandoc(1) to warn about broken .Xr links;

probably cannot be on by default in -Tlint because it needs

to access the manpath and mandoc.db(3) after parsing.

asked for by jmc@ Fri, 4 Dec 2015 22:39:40 +0000

- warn when .Sh or .Ss contain other macros

Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034

loc * exist * algo * size * imp **

Line 539 are mere guesses, and some may be wrong.

Line 493 are mere guesses, and some may be wrong.

all over mdoc_macro.c and all subtly different.

loc ** exist ** algo ** size ** imp **

- warn about "new sentence, new line"

loc ** exist ** algo *** size * imp **

- mandoc_special does not really check the escape sequence,

but just the overall format

loc ** exist ** algo *** size ** imp **

- integrate mdoclint into mandoc ("end-of-line whitespace" thread)

from jmc@ Mon, 13 Jul 2009 17:12:09 +0100

from kristaps@ Mon, 13 Jul 2009 18:34:53 +0200

from jmc@ Mon, 13 Jul 2009 17:45:37 +0059

from kristaps@ Mon, 13 Jul 2009 19:02:03 +0200

(mostly done, check what remains)

- -Tlint parser errors and warnings to stdout

to tech@mdocml, naddy@ Wed, 28 Sep 2011 11:21:46 +0200

wait! kristaps@ Sun, 02 Oct 2011 17:12:52 +0200

Line 561 are mere guesses, and some may be wrong.

Line 505 are mere guesses, and some may be wrong.

* documentation issues

************************************************************************

- mention hyphenation rules:

breaking at letter-letter in text mode (not macro args)

proper hyphenation is unimplemented

- talk about spacing around delimiters

to jmc@, kristaps@ Sat, 23 Apr 2011 17:41:27 +0200

- mark macros as: page structure domain, manual domain, general text domain

is this useful?

Line 585 are mere guesses, and some may be wrong.

Line 522 are mere guesses, and some may be wrong.

Several areas can be cleaned up to make mandoc even faster. These are

- improve hashing mechanism for macros (quite important: performance)

- improve hashing mechanism for characters (not as important)

- the PDF file is HUGE: this can be reduced by using relative offsets

- instead of re-initialising the roff predefined-strings set before each

parse, create a read-only version the first time and copy it

loc * exist ** algo ** size * imp **

************************************************************************

* structural issues

************************************************************************

Line 613 Several areas can be cleaned up to make mandoc even fa

Line 542 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.

- Finish cleanup of date handling.

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

- struct mparse refactoring

Steffen Nurpmeso Thu, 04 Sep 2014 12:50:00 +0200

Line 629 Several areas can be cleaned up to make mandoc even fa

Line 553 Several areas can be cleaned up to make mandoc even fa

output through libz.

- Sandbox (see OpenSSH).

- Enable caching support via HTTP 304 and If-Modified-Since.

- Allow for cgi.h to be overridden by CGI environment variables.

Otherwise, binary distributions will inherit the compile-time

behaviour, which is not optimal.

- Have Mac OSX systems automatically disable -static compilation of the

CGI: -static isn't supported.

Line 641 Several areas can be cleaned up to make mandoc even fa

Line 562 Several areas can be cleaned up to make mandoc even fa

- use uname(1) to set doc-default-operating-system at install time

tobimensch Mon, 1 Dec 2014 00:25:07 +0100

- apostrophe (39), circumflex (94), grave (96), tilde (126)

in manuals: \(aq, \(ha, \`, \(ti

Re: [Groff] ASCII Minus Sign in man Pages.

bentley@ 26 Apr 2017 10:02:06 -0600

Do we need to fix existing manuals?

Do we need to fix the definition of the mdoc(7) language?

CVSweb