public inbox for gcc-patches@gcc.gnu.org
 help / color / mirror / Atom feed
From: Jakub Jelinek <jakub@redhat.com>
To: Jonathan Wakely <jwakely@redhat.com>
Cc: gcc-patches@gcc.gnu.org
Subject: Re: [ping] [wwwdocs] Add reference to pp_format to Coding Conventions
Date: Tue, 18 Oct 2022 13:27:01 +0200	[thread overview]
Message-ID: <Y06NhXyQXFZzpTER@tucnak> (raw)
In-Reply-To: <Y06KvPa5EeXFijaV@redhat.com>

On Tue, Oct 18, 2022 at 12:15:08PM +0100, Jonathan Wakely via Gcc-patches wrote:
> ping...
> 
> On 21/09/22 10:39 +0100, Jonathan Wakely wrote:
> > Finding the docs for the GCC-specific diagnostic formats isn't easy.
> > This might help.
> > 
> > OK for wwwdocs?
> 
> -- >8 --
> 
>  htdocs/codingconventions.html | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/htdocs/codingconventions.html b/htdocs/codingconventions.html
> index e4d30510..f1d1f165 100644
> --- a/htdocs/codingconventions.html
> +++ b/htdocs/codingconventions.html
> @@ -333,7 +333,8 @@ code token.</li>
>  <li>Diagnostics using the GCC diagnostic functions should generally
>  use the GCC-specific formats such as <code>%qs</code> or
>  <code>%&lt;</code> and <code>%&gt;</code> for quoting and
> -<code>%m</code> for <code>errno</code> numbers.</li>
> +<code>%m</code> for <code>errno</code> numbers. See
> +<tt>pp_format</tt> in <tt>pretty-print.cc</tt> for supported formats.</li>

I'm afraid pretty-print.cc covers only some of them.
E.g. tree-diagnostic.cc (default_tree_printer) adds several important
ones (%T, %E, %D and %F; but unfortunately we don't document those like
the comment about pp_format does).
Then there are the C++ specific formats, cp/error.cc (cp_printer) comment
documents those.
fortran/error.cc (error_print) comment similarly for Fortran FE specific
modifiers.
dumpfile.cc (dump_pretty_printer::decode_format) documents its extensions
too.

	Jakub


      reply	other threads:[~2022-10-18 11:27 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-21  9:39 Jonathan Wakely
2022-10-18 11:15 ` [ping] " Jonathan Wakely
2022-10-18 11:27   ` Jakub Jelinek [this message]

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=Y06NhXyQXFZzpTER@tucnak \
    --to=jakub@redhat.com \
    --cc=gcc-patches@gcc.gnu.org \
    --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).