This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [doc patch] Rename "Language Independent Options" @node in invoke.texi


On 07/21/2015 06:52 AM, Jonathan Wakely wrote:
This texinfo @node seems misnamed:
https://gcc.gnu.org/onlinedocs/gcc/Language-Independent-Options.html#Language-Independent-Options


It should be something like "Diagnostic Message Formatting Options"
not "Language Independent Options".

The misnomer makes the TOC and navbar confusing and seems to suggest
that warning and debuging options are not language independent, since
they're not part of that node. See
https://gcc.gnu.org/onlinedocs/gcc/Invoking-GCC.html#Invoking-GCC
which has:

* Language Independent Options: Controlling how diagnostics should be
formatted.
* Warning Options: How picky should the compiler be?
* Debugging Options: Symbol tables, measurements, and debugging dumps.
* Optimize Options: How much optimization?
The title of the first entry is completely unrelated to its
description.

An alternative fix would be to keep a "Language Independent Options"
node but nest "Diagnostic Message Formatting Options", "Warning
Options", "Debugging Options" and "Optimize Options" as sub-sections
of it. The downside of that is that it would be harder to find those
sub-sections from the
https://gcc.gnu.org/onlinedocs/gcc/Invoking-GCC.html#Invoking-GCC
node, as you'd have to click through to another page to see the
sub-sections.

OK for trunk?

I agree with the proposed renaming of the node, but you need to fix all the references to the old name and not just the @node, so no, the patch is not OK as-is.

-Sandra


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]