mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.282 and 1.304

version 1.282, 2019/01/04 03:39:01

version 1.304, 2020/06/24 12:09:29

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

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

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

- \\ in high-level macro arguments

- .als only works for macros in mandoc, not for user-defined strings.

Currently, \\ is expanded in two situations:

Also, the "val" field in struct roffkv would have to be replaced

1) macro and string definition (roff.c setstrn())

with a pointer to a reference-counted wrapper, and an alias

2) macro argument parsing (mandoc.c mandoc_getarg())

would have to point to the same wrapper as the original.

For user defined macros, the second happens in time because of ROFF_REPARSE.

.als to undefined does nothing; the alias is not created.

But for standard high-level macros, it only happens after entering the

.rm'ing the original leaves the alias to point to the old value.

high level parsers, which is too late because the code doesn't get

.de .als .de changes both, but

back to roff.c roff_res() from that point. Because this requires

.de .als .rm .de only changes the new value, not the alias.

distinguishing requests, user-defined macros and standard macros

Found in groffer(1) version 1.19

on the roff_res() level, it is hard to solve without the parser reorg.

Jan Stary 20 Apr 2019 20:16:54 +0200

Found by naddy@ in devel/cutils cobfusc(1) Mon, 16 Feb 2015 19:10:52 +0100

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

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

- roff string condition comparisons fail when vars contain quotes:

.ds s '

.if '\*s'' \&...

hard to fix because of the basic architecture (string replacement

happens before roff(7) syntax parsing)

Found in groffer(1) version 1.19

Jan Stary 20 Apr 2019 20:16:54 +0200

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

- mandoc replaces all ASCII control characters except tab and line feed

with '?' during input. It would be better to replace them with

Unicode escapes in preconv_encode() or somewhere in the vicinity,

such that the already existing better replacement strings show

up in the output. Emulating groff is not desirable: groff replaces

0x00, 0x0b, and 0x0d to 0x1f with the empty string (bad because

that's easy to overlook for the document author), 0x01 with '.'

(very confusing), and passes through 0x02 to 0x08, 0x0c, and 0x7f

raw (bad because that is insecure output). Remember that 0x07 may

need special handling because it is sometimes used for certain

delimiters, so it may need handling *after* roff.c rather than before.

reminded by John Gardner 16 Jun 2020 14:26:28 +1000

Actually, more ASCII control characters than just 0x07 may need

later handling because they can for example be used in macro names.

So they may need handling after roff(7) processing.

pointed out by John Gardner 23 Jun 2020 18:28:08 +1000

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

--- missing mdoc features ----------------------------------------------

- .Sh and .Ss should be parsed and partially callable, see groff_mdoc(7)

reed at reedmedia dot net Sat, 21 Dec 2019 17:13:07 -0600

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

- .Bl -column .Xo support is missing

ultimate goal:

restore .Xr and .Dv to

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

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

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

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

they use some unsupported tbl(7) features.

they use some unsupported tbl(7) features, mostly macros in tbl(7).

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

- look what Joerg Schilling manual pages use

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

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

--- missing eqn features -----------------------------------------------

- In a matrix, break the output line after each matrix line.

Found in the discussion at CDBUG 2015.

Found in the discussion at CDBUG 2015. Suggested by Avi Weinstock.

Suggested by Avi Weinstock.

This may not be the ideal solution after all: eqn(7) matrices

loc * exist * algo * size * imp **

are lists of columns, so Avi's proposal would show each *column*

on its own *line*, which is likely to cause confusion.

A better solution, but much harder to implement, would be to

actually show the coordinates of column vectors on different

terminal output lines, using the clumnated output facilities

developed for .Bl -tag, .Bl -column, and also used for tbl(7).

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

- The "size" keyword is parsed, but ignored by the formatter.

loc * exist * algo * size * imp *

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

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

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

- -T man does not handle eqn(7) and tbl(7)

Stephen Gregoratto 16 Feb 2020 01:28:07 +1100

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

- man -ks 1,8 route; kn@ Jul 13, 2018 orally

- italic correction (\/) in PostScript mode

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

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

https://github.com/schmonz/ikiwiki/compare/mandoc

Amitai Schlair Mon, 19 May 2014 14:05:53 -0400

- check compatibility with

https://git.sr.ht/~sircmpwn/scdoc

- check features of the Slackware man.conf(5) format

Carsten Kunze Wed, 11 Mar 2015 17:57:24 +0100

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

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

- a line starting with "\fB something" counts as starting with whitespace

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

This will become easier once escape sequences are represented

by syntax tree nodes.

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

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

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

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

--- HTML issues --------------------------------------------------------

- wrap Sh and Ss content into <div>

- get rid of the last handful of style= attributes such that

Laura Morales <lauretas at mail dot com> 21 Apr 2018 18:10:48 +0200

Content-Security-Policy: can be enabled without unsafe-inline

(Evaluate whether this is really useful and has no adverse

suggested by bentley@ Nov 10, 2019 at 06:02:49AM -0700

side effects before implementing; if it is possible,

loc * exist * algo * size * imp **

it does seem cleaner.)

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

- .IP wants vertical spacing before itself;

currently, it is formatted like .Bl -compact.

Fixing this requires getting rid of the "float"

in the CSS for .Bl-tag first.

Reminded by Pali Rohar 25 Oct 2018 10:10:35 +0200.

- format multiple subsequent .IP as a single list

rather than opening a new list for each item

Pali Rohar 25 Nov 2018 14:34:26 +0100

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

- format ".IP *" etc. as <ul> rather than <dl>

https://github.com/Debian/debiman/issues/67

reminded by Pali Rohar 25 Nov 2018 14:34:26 +0100

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

- .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal

space, see for example random(3). Introduced in

http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92

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

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

https://github.com/Debian/debiman/issues/15

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

- space characters can end up in href= attributes, for example coming

from the first .Xr argument (where they make no sense, but still);

does this affect other characters, other source macros...?

Jackson Pauls 29 Aug 2017 16:56:27 +0100

- The tables used to render the three-part page headers actually force

the width of the <body> to the max-width given for <html>.

Not yet sure how to fix that...

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

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

* warning issues

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

- When a man(1) command returns no result and there was an -S

argument, check the -S argument against the list of valid

architectures and say "Unknown architecture AAA" rather than

"No entry for NNN in the manual" if there is no match.

Requires moving the lists of valid architectures out of

mdoc_validate.c such that they can be used by main.c.

Discussed with jmc@ 10 Aug 2018 19:20:12 +0100.

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

- warn about duplicate .Sh/.Ss heads

gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200

loc * exist * algo * size * imp **

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

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

all over mdoc_macro.c and all subtly different.

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

- style message about suspicious uses of - vs. \- vs. \(mi

e.g. -1 is likely wrong (from the mdoclint TODO)

- warn about punctuation - e.g. ',' and ';' - at the beginning

of a text line, if it is likely intended to follow the preceding

output without intervening whitespace, in particular after a

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

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

* documentation issues

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

- dashes, hyphens, and minus signs in manual pages

jmc@ Fri, 28 Mar 2014 07:19:27 +0000

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

is this useful?

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

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

Found by Aaron M. Ucko in the GNU Hurd via Bdale Garbee,

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=829624

- We use the input line number at several places to distinguish

same-line from different-line input. That plainly doesn't work

with user-defined macros, leading to random breakage.

- Is it possible to further simplify ENDBODY_SPACE?

- Find better ways to prevent endless loops

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

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

* CGI issues

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

- Inspect httpd(8) logs on man.openbsd.org and consider

whether logging can be improved, where bad syntax comes from,

and what needs to be done to get rid of COMPAT_OLDURI.

- Enable HTTP compression by detecting gzip encoding and filtering

output through libz.

- Privilege separation (see OpenSSH).

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

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

CGI: -static isn't supported.

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

* to improve in the groff_mdoc(7) macros

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

- delete OS release verification from .Dx, .Fx, .Nx, .Ox etc.

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=629161

also Branden Robinson 18 Dec 2019 00:59:52 +1100

- Can the distinction between .Vt and .Va be made stricter,

recommending .Vt extern char * Ns Va optarg ; ?

What about the block macro properties of .Vt in the SYNOPSIS?

zeurkous 25 Dec 2019 08:48:36 +0100

- .Cd # arch1, arch2 in section 4 pages:

find better way to indicate multiple architectures, maybe:

CVSweb