libgdiagnostics: documentation tweaks

gcc/ChangeLog:
	* doc/libgdiagnostics/topics/execution-paths.rst: Add '§' before
	references to section of SARIF spec.
	* doc/libgdiagnostics/topics/fix-it-hints.rst: Likewise.
	* doc/libgdiagnostics/tutorial/01-hello-world.rst: Fix typo.
	* doc/libgdiagnostics/tutorial/02-physical-locations.rst: Likewise.
	* doc/libgdiagnostics/tutorial/04-notes.rst: Likewise.
	* doc/libgdiagnostics/tutorial/06-fix-it-hints.rst: Add link to
	diagnostic_add_fix_it_hint_replace.
	* doc/libgdiagnostics/tutorial/07-execution-paths.rst: Add '§'.

Signed-off-by: David Malcolm <dmalcolm@redhat.com>

diff --git a/gcc/doc/libgdiagnostics/topics/execution-paths.rst b/gcc/doc/libgdiagnostics/topics/execution-paths.rst
index 3f4109ce4f33b1893405e5ac2308e2d564ed27cc..01bb95f016e9f1305a68e53deded8437262c7a9a 100644 (file)
--- a/gcc/doc/libgdiagnostics/topics/execution-paths.rst
+++ b/gcc/doc/libgdiagnostics/topics/execution-paths.rst
@@ -90,4 +90,4 @@ cross-references between events.  In particular FIXME
 
 Paths are printed to text sinks, and for SARIF sinks each path is added as
 a ``codeFlow`` object (see SARIF 2.1.0
-`3.36 codeFlow object <https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790990>`_).
+`§3.36 codeFlow object <https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790990>`_).

diff --git a/gcc/doc/libgdiagnostics/topics/fix-it-hints.rst b/gcc/doc/libgdiagnostics/topics/fix-it-hints.rst
index 08acb7119a14a1e087436a872ea4ee78e0c56017..6854ea0d14d80de60851699caa1cf376e619e82e 100644 (file)
--- a/gcc/doc/libgdiagnostics/topics/fix-it-hints.rst
+++ b/gcc/doc/libgdiagnostics/topics/fix-it-hints.rst
@@ -40,7 +40,7 @@ to add fix-it hints without each needing extensive checking.
 
 Fix-it hints are printed to text sinks, and are emitted by SARIF sinks
 as ``fix`` objects (see SARIF 2.1.0
-`3.55 fix object <https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141791131>`_).
+`§3.55 fix object <https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141791131>`_).
 
 Fix-it hints within a :type:`diagnostic` are "atomic": if any hints can't
 be applied, none of them will be, and no fix-its hints will be displayed

diff --git a/gcc/doc/libgdiagnostics/tutorial/01-hello-world.rst b/gcc/doc/libgdiagnostics/tutorial/01-hello-world.rst
index 6596734546fbd53e37c243ad118c238deb0c028b..f616d27e2ceb6bc3127fb7f99e6ea92f53e460fa 100644 (file)
--- a/gcc/doc/libgdiagnostics/tutorial/01-hello-world.rst
+++ b/gcc/doc/libgdiagnostics/tutorial/01-hello-world.rst
@@ -124,7 +124,7 @@ terminal, and the quotes will be internationalized, so that e.g. with
 
 .. code-block:: console
 
-  progname: erreur: can't find « free »
+  progname: erreur: can't find « foo »
 
 Note that:
 

diff --git a/gcc/doc/libgdiagnostics/tutorial/02-physical-locations.rst b/gcc/doc/libgdiagnostics/tutorial/02-physical-locations.rst
index 71d836edb28cc4955804ee4469eeee9d653f3c3a..cb7aefbf81b737494fe40a4f5c1d181f34593396 100644 (file)
--- a/gcc/doc/libgdiagnostics/tutorial/02-physical-locations.rst
+++ b/gcc/doc/libgdiagnostics/tutorial/02-physical-locations.rst
@@ -165,7 +165,7 @@ underling the pertinent part of the given line.
 
 If libgdiagnostics cannot open the file, it will merely print::
 
-   foo.c:17:8: error: can't find 'foo'
+   foo.c:17:8: error: can't find 'foo.h'
 
 A range can span multiple lines within the same file.
 

diff --git a/gcc/doc/libgdiagnostics/tutorial/04-notes.rst b/gcc/doc/libgdiagnostics/tutorial/04-notes.rst
index 81755b220be7c2b9e960df50cfc976df9330c730..da03af05f492258dfcbfd78430865a0751d607c1 100644 (file)
--- a/gcc/doc/libgdiagnostics/tutorial/04-notes.rst
+++ b/gcc/doc/libgdiagnostics/tutorial/04-notes.rst
@@ -24,7 +24,7 @@ Let's further extend the previous example to add a "note" to it.
 
 We want to generate output like this::
 
-   test-with-note.c:17:11: error: can't find 'foo'
+   test-with-note.c:17:11: error: can't find 'foo.h'
    17 | #include <foo.h>
       |           ^~~~~
    test-with-note.c:17:11: note: have you looked behind the couch?
@@ -42,7 +42,7 @@ to the diagnostics.
 
 On compiling and running the program, we should get the desired output::
 
-   test-with-note.c:17:11: error: can't find 'foo'
+   test-with-note.c:17:11: error: can't find 'foo.h'
    17 | #include <foo.h>
       |           ^~~~~
    test-with-note.c:17:11: note: have you looked behind the couch?

diff --git a/gcc/doc/libgdiagnostics/tutorial/06-fix-it-hints.rst b/gcc/doc/libgdiagnostics/tutorial/06-fix-it-hints.rst
index f3c32ad1ce2d86a4f2bd0fbc5445747f288fc51d..35af4c82c0cace75c4a60753e9f804ef5781ebe4 100644 (file)
--- a/gcc/doc/libgdiagnostics/tutorial/06-fix-it-hints.rst
+++ b/gcc/doc/libgdiagnostics/tutorial/06-fix-it-hints.rst
@@ -24,7 +24,8 @@ libgdiagnostics supports adding "fix-it hints" to a :type:`diagnostic`:
 suggestions for the user on how to edit their code to fix a problem.  These
 can be expressed as insertions, replacements, and removals of text.
 
-For example, here we add a replacement fix-it hint to a diagnostic:
+For example, here we use :func:`diagnostic_add_fix_it_hint_replace` to add
+a replacement fix-it hint to a diagnostic:
 
 .. literalinclude:: ../../../testsuite/libgdiagnostics.dg/test-fix-it-hint.c
    :language: c

diff --git a/gcc/doc/libgdiagnostics/tutorial/07-execution-paths.rst b/gcc/doc/libgdiagnostics/tutorial/07-execution-paths.rst
index 3c0ba715418448913035665447ded0924c64e6ac..3b626c01aca430a479fde45c2ef16a52384ce447 100644 (file)
--- a/gcc/doc/libgdiagnostics/tutorial/07-execution-paths.rst
+++ b/gcc/doc/libgdiagnostics/tutorial/07-execution-paths.rst
@@ -124,7 +124,7 @@ then we should get output to text sinks similar to the following::
          |     (3) when calling 'PyList_Append', passing NULL from (1) as argument 1
 
 and for SARIF sinks the path will be added as a ``codeFlow`` object
-(see SARIF 2.1.0 `3.36 codeFlow object <https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790990>`_).
+(see SARIF 2.1.0 `§3.36 codeFlow object <https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790990>`_).
 
 Here's the above example in full: