[m-rev.] for post-commit review: implement --help-texinfo

Zoltan Somogyi zoltan.somogyi at runbox.com
Fri Jul 4 03:13:20 AEST 2025


This diff gets us close to the point where we can generate
the contents of the Invocation chapter of the User's Guide
automatically, but we are not there yet. There are five references
to the Invocation chapter in the rest of the user guide that become
dangling links when the output of mmc --help-texinfo replaces
the invocation chapter, and until those are fixed, I cannot show
you what the updated user guide would look like.

Before I can get there, I need to make some decisions that
I would like your feedback on.

First, at the moment, the user guide's documentation of the
--grade option is *much* more extensive than the corresponding help text in mmc --help. Where should this be put? The obvious answer is a new chapter in the user's guide, but where should
that chapter be?

The two possible answers I see are (a) just before the current invocation
chapter, and (b) somewhere around the current sections 3 and 4 (Using mmc 
and running programs respectively). I would be fine with either, but would
prefer the latter, because both sections 3 and 4 already talk about
grade-specific stuff, but do not explicitly call this out.

Second, some of the dangling links are in descriptions of smart recompilation.
As far as I know, that functionality was never finished, and is not ready
for prime time. As such, I think the right fix is to comment out all the text
that talks about smart recompilation, and make the related options private.

What do you guys think?

The diff is for review by anyone. Note that I made the copying of help text
to the user guide a manual process because that is what we need now,
but I would not be averse to making the process automatic once the
switchover of the invocation chapter is complete, and the process has
worked reliably for a while.

Zoltan.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Log.hti
Type: application/octet-stream
Size: 626 bytes
Desc: not available
URL: <http://lists.mercurylang.org/archives/reviews/attachments/20250703/a7a3d6ff/attachment-0002.obj>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: DIFF.hti
Type: application/octet-stream
Size: 84163 bytes
Desc: not available
URL: <http://lists.mercurylang.org/archives/reviews/attachments/20250703/a7a3d6ff/attachment-0003.obj>


More information about the reviews mailing list