public inbox for gcc-patches@gcc.gnu.org
 help / color / mirror / Atom feed
From: Sandra Loosemore <sandra@codesourcery.com>
To: Jonathan Wakely <jwakely@redhat.com>
Cc: <gcc-patches@gcc.gnu.org>, Gerald Pfeifer <gerald@pfeifer.com>
Subject: Re: [doc patch] Rename "Language Independent Options" @node in invoke.texi
Date: Tue, 21 Jul 2015 15:37:00 -0000	[thread overview]
Message-ID: <55AE603D.10807@codesourcery.com> (raw)
In-Reply-To: <20150721125201.GR21787@redhat.com>

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

  reply	other threads:[~2015-07-21 15:09 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-07-21 12:54 Jonathan Wakely
2015-07-21 15:37 ` Sandra Loosemore [this message]
2015-07-22  0:07   ` Jonathan Wakely
2015-07-22  7:08     ` Sandra Loosemore

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=55AE603D.10807@codesourcery.com \
    --to=sandra@codesourcery.com \
    --cc=gcc-patches@gcc.gnu.org \
    --cc=gerald@pfeifer.com \
    --cc=jwakely@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).