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

Zoltan Somogyi zoltan.somogyi at runbox.com
Sat Jul 5 19:22:10 AEST 2025



On Thu, 03 Jul 2025 19:13:20 +0200 (CEST), "Zoltan Somogyi" <zoltan.somogyi at runbox.com> wrote:

> 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?

Does anyone intend to answer the questions above?

Zoltan.





More information about the reviews mailing list