public inbox for gcc-patches@gcc.gnu.org
 help / color / mirror / Atom feed
From: "Manuel López-Ibáñez" <lopezibanez@gmail.com>
To: David Malcolm <dmalcolm@redhat.com>,
	GCC Patches <gcc-patches@gcc.gnu.org>
Subject: Re: [PATCH 2/2] Documentation hyperlinks for [-Wname-of-option] (PR 87488)
Date: Thu, 10 Oct 2019 17:49:00 -0000	[thread overview]
Message-ID: <76aaf78a-ec19-4f6d-abd5-965034007b2c@gmail.com> (raw)
In-Reply-To: <20191010170614.2061-2-dmalcolm@redhat.com>

Hi David,

While I agree that this is quite cool to have, the following:

> +    /* DOCUMENTATION_ROOT_URL should be supplied via -D by the Makefile
> +       (see --with-documentation-root-url).
> +
> +       Expect an anchor of the form "index-Wfoo" e.g.
> +       <a name="index-Wformat"></a>, and thus an id within
> +       the URL of "#index-Wformat".  */
> +    return concat (DOCUMENTATION_ROOT_URL,
> +		   "Warning-Options.html",
> +		   "#index", cl_options[option_index].opt_text,
> +		   NULL);

will not work for many -W options:

https://gcc.gnu.org/onlinedocs/gcc/C_002b_002b-Dialect-Options.html#C_002b_002b-Dialect-Options
(scroll to the bottom)

https://gcc.gnu.org/onlinedocs/gcc/Objective-C-and-Objective-C_002b_002b-Dialect-Options.html#Objective-C-and-Objective-C_002b_002b-Dialect-Options
(scroll to the bottom)

https://gcc.gnu.org/onlinedocs/gcc-9.2.0/cpp/Invocation.html#index-Wcomment

https://gcc.gnu.org/onlinedocs/gcc-9.2.0/gfortran/Error-and-Warning-Options.html#Error-and-Warning-Options

I would argue that some options are documented in the wrong place (I think all 
C/C++ -W options should just go to Warning-Options.html), but I also believe 
the HTML page should be language dependent.

Cheers,

Manuel.

  reply	other threads:[~2019-10-10 17:45 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-10 17:06 [PATCH 1/2] pretty-print: support URL escape sequences " David Malcolm
2019-10-10 17:19 ` [PATCH 2/2] Documentation hyperlinks for [-Wname-of-option] " David Malcolm
2019-10-10 17:49   ` Manuel López-Ibáñez [this message]
2019-10-11  3:54     ` Eric Gallager
2019-10-14 16:35   ` Michael Matz
2019-12-06 23:41 ` [PATCH 1/2] pretty-print: support URL escape sequences " Jakub Jelinek
2019-12-07  1:31   ` David Malcolm
2019-10-12  7:28 [PATCH 2/2] Documentation hyperlinks for [-Wname-of-option] " Bernd Edlinger
2019-10-12 14:51 ` David Malcolm
2019-10-12 15:43   ` Bernd Edlinger
2019-10-12 18:10   ` Segher Boessenkool

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=76aaf78a-ec19-4f6d-abd5-965034007b2c@gmail.com \
    --to=lopezibanez@gmail.com \
    --cc=dmalcolm@redhat.com \
    --cc=gcc-patches@gcc.gnu.org \
    /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).