[m-rev.] for post-commit review: proposed help text structure

[Julien Fischer]

On Fri, 20 Jun 2025 at 05:35, Zoltan Somogyi <zoltan.somogyi at runbox.com> wrote:
>
> This is not worth reviewing yet. What is worth reviewing is the
> file showing the overall structure that I am proposing for help text.

> Help options
> Options for modifying the command line
> Options that give the compiler its overall task
> Grade options
> Options that control inference
> Options specifying the intended semantics
> Verbosity options
> Warning options
>     Warnings about possible incorrectness
>     Warnings about possible performance issues
>     Warnings about programming style
>     Options that control warnings
>     Options about halting for warnings
> Options that request information
> Options that ask for informational files
> Controlling trace goals
> Diagnostics options
>     Options that control diagnostics
>     Options that control color in diagnostics

I would be inclined to move "Diagonstics options" to
before "Warning options" (and at the very list to before
"Controlling trace goals".

> Preparing code for mdb debugging
> Preparing code for mdprof profiling
> Optimization options
>     Overall control of optimizations
>     Source-to-Source optimizations
>     Experimental source-to-Source optimizations

s/Source/source/

>     Optimizations during code generation
>     Optimizations specific to high level code
>     Optimizations specific to low level code
> Options that control transitive intermodule optimization
> Options that control program analyses
> Options that ask for modified output
> Options for controlling mmc --make
> Options for target language compilation
>     General options for compiling target language code
>     Options for compiling C code
>     Options for compiling Java code
>     Options for compiling C# code
> Options for linking
>     General options for linking
>     Options for linking C or C# code
>     Options for linking just C code
>     Options for linking just Java code
>     Options for linking just C# code
> Options controlling searches for files
> Options controlling the library installation process
> Options specifying properties of the environment
> Options that record autoconfigured parameters
> Options reserved for Mercury.config files
> Options for developers only
>     Operation selection options for developers only
>     Options that can help debug the compiler
>     Options for dumping internal compiler data structures
>     Options intended for internal use by the compiler only
> Now-unused former options kept for compatbility

s/compatbility/compatibility/

Julien.