diff mbox series

[ping,wwwdocs] Add reference to pp_format to Coding Conventions

Message ID Y06KvPa5EeXFijaV@redhat.com
State Unresolved
Headers
Series [ping,wwwdocs] Add reference to pp_format to Coding Conventions |

Checks

Context Check Description
snail/gcc-patch-check warning Git am fail log

Commit Message

Jonathan Wakely Oct. 18, 2022, 11:15 a.m. UTC 
  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(-)

Comments

Jakub Jelinek Oct. 18, 2022, 11:27 a.m. UTC | #1 
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
diff mbox series

Patch

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>

  <li>Identifiers should generally be formatted with <code>%E</code> or
  <code>%qE</code>; use of <code>identifier_to_locale</code> is needed