[DOCS,pushed] Improve JSON examples.

Message ID 6c2a399e-02c8-cbe0-1cd1-d77c044ff1a8@suse.cz
State New
Headers show
Series
  • [DOCS,pushed] Improve JSON examples.
Related show

Commit Message

Martin Liška June 9, 2021, 5:54 a.m.
The patch improves JSON examples so that they are a valid JSON.
That will help us with syntax highlighting in Sphinx-generated
documentation.

Pushed to master.
Martin

gcc/ChangeLog:

	* doc/gcov.texi: Create a proper JSON files.
	* doc/invoke.texi: Remove dots in order to make it a valid
	JSON object.
---
  gcc/doc/gcov.texi   | 50 ++++++++++++++++++++++-----------------------
  gcc/doc/invoke.texi |  3 +--
  2 files changed, 26 insertions(+), 27 deletions(-)

-- 
2.31.1

Patch

diff --git a/gcc/doc/gcov.texi b/gcc/doc/gcov.texi
index 32b51f984bc..6a5760e5ebe 100644
--- a/gcc/doc/gcov.texi
+++ b/gcc/doc/gcov.texi
@@ -191,11 +191,11 @@  Structure of the JSON is following:
  
  @smallexample
  @{
-  "current_working_directory": @var{current_working_directory},
-  "data_file": @var{data_file},
-  "format_version": @var{format_version},
-  "gcc_version": @var{gcc_version}
-  "files": [@var{file}]
+  "current_working_directory": "foo/bar",
+  "data_file": "a.out",
+  "format_version": "1",
+  "gcc_version": "11.1.1 20210510"
+  "files": ["$file"]
  @}
  @end smallexample
  
@@ -220,9 +220,9 @@  Each @var{file} has the following form:
  
  @smallexample
  @{
-  "file": @var{file_name},
-  "functions": [@var{function}],
-  "lines": [@var{line}]
+  "file": "a.c",
+  "functions": ["$function"],
+  "lines": ["$line"]
  @}
  @end smallexample
  
@@ -237,15 +237,15 @@  Each @var{function} has the following form:
  
  @smallexample
  @{
-  "blocks": @var{blocks},
-  "blocks_executed": @var{blocks_executed},
-  "demangled_name": "@var{demangled_name},
-  "end_column": @var{end_column},
-  "end_line": @var{end_line},
-  "execution_count": @var{execution_count},
-  "name": @var{name},
-  "start_column": @var{start_column}
-  "start_line": @var{start_line}
+  "blocks": 2,
+  "blocks_executed": 2,
+  "demangled_name": "foo",
+  "end_column": 1,
+  "end_line": 4,
+  "execution_count": 1,
+  "name": "foo",
+  "start_column": 5,
+  "start_line": 1
  @}
  @end smallexample
  
@@ -289,11 +289,11 @@  Each @var{line} has the following form:
  
  @smallexample
  @{
-  "branches": [@var{branch}],
-  "count": @var{count},
-  "line_number": @var{line_number},
-  "unexecuted_block": @var{unexecuted_block}
-  "function_name": @var{function_name},
+  "branches": ["$branch"],
+  "count": 2,
+  "line_number": 15,
+  "unexecuted_block": false,
+  "function_name": "foo",
  @}
  @end smallexample
  
@@ -320,9 +320,9 @@  Each @var{branch} has the following form:
  
  @smallexample
  @{
-  "count": @var{count},
-  "fallthrough": @var{fallthrough},
-  "throw": @var{throw}
+  "count": 11,
+  "fallthrough": true,
+  "throw": false
  @}
  @end smallexample
  
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 6063e466c13..24dc0491901 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -5149,8 +5149,7 @@  might be printed in JSON form (after formatting) like this:
              @}
          ]
  	"column-origin": 1,
-    @},
-    @dots{}
+    @}
  ]
  @end smallexample