From 1a50c42806eb3f22047e44669c26721501b9d164 Mon Sep 17 00:00:00 2001 From: David Malcolm Date: Thu, 15 Nov 2018 15:18:43 +0000 Subject: [PATCH] doc/ux.texi: auto_diagnostic_group now does something As of r266186, auto_diagnostic_group is now user-visible (via -fdiagnostics-format=json), so update the diagnostic guidelines accordingly. gcc/ChangeLog: * doc/ux.texi (Group logically-related diagnostics): Move discussion of auto_diagnostic_group into this new subsection. Give an example of where this grouping is used. From-SVN: r266187 --- gcc/ChangeLog | 6 ++++++ gcc/doc/ux.texi | 9 ++++++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/gcc/ChangeLog b/gcc/ChangeLog index 8555d42d009..45fbfe1a2ec 100644 --- a/gcc/ChangeLog +++ b/gcc/ChangeLog @@ -1,3 +1,9 @@ +2018-11-15 David Malcolm + + * doc/ux.texi (Group logically-related diagnostics): Move + discussion of auto_diagnostic_group into this new subsection. + Give an example of where this grouping is used. + 2018-11-15 David Malcolm PR other/19165 diff --git a/gcc/doc/ux.texi b/gcc/doc/ux.texi index 3b395f24df1..47b44921793 100644 --- a/gcc/doc/ux.texi +++ b/gcc/doc/ux.texi @@ -376,12 +376,15 @@ where the @code{double} and @code{int} are colorized to highlight them. @c %H and %I were added in r248698. +@subsection Group logically-related diagnostics + Use @code{auto_diagnostic_group} when issuing multiple related diagnostics (seen in various examples on this page). This informs the diagnostic subsystem that all diagnostics issued within the lifetime -of the @code{auto_diagnostic_group} are related. (Currently it doesn't -do anything with this information, but we may implement that in the -future). +of the @code{auto_diagnostic_group} are related. For example, +@option{-fdiagnostics-format=json} will treat the first diagnostic +emitted within the group as a top-level diagnostic, and all subsequent +diagnostics within the group as its children. @subsection Quoting Text should be quoted by either using the @samp{q} modifier in a directive -- 2.30.2