aboutsummaryrefslogtreecommitdiff
path: root/libbuild2/b.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2023-05-09 15:05:13 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2023-05-09 15:37:47 +0200
commita0628f5c2968d6bb904c52f9a06a16c679f92e70 (patch)
tree5678a459bf3f3619a798a5944624578096a6f16e /libbuild2/b.cli
parentb5d143f529e4ebbeb7a1746312e38da815e2e321 (diff)
Document JSON dump format (GH issue #182)
Diffstat (limited to 'libbuild2/b.cli')
-rw-r--r--libbuild2/b.cli10
1 files changed, 5 insertions, 5 deletions
diff --git a/libbuild2/b.cli b/libbuild2/b.cli
index c9dfddd..1c994df 100644
--- a/libbuild2/b.cli
+++ b/libbuild2/b.cli
@@ -798,7 +798,7 @@ namespace build2
string --dump-format
{
- // NOTE: fix all references to json-v0.1
+ // NOTE: fix all references to json-v0.1, including the manual.
//
"<format>",
"Representation format and output stream to use when dumping the build
@@ -808,9 +808,9 @@ namespace build2
written to \cb{stdout}). For details on the \cb{buildfile} format, see
\l{b#intro-diag-debug Diagnostics and Debugging}. For details on the
\cb{json-v0.1} format, see the JSON OUTPUT section below (overall
- properties) and \l{b#@@ Build System State JSON Dump Format} (format
- specifics). Note that the JSON format is currently unstable (thus
- the temporary \cb{-v0.1} suffix).
+ properties) and \l{b#json-dump JSON Dump Format} (format specifics).
+ Note that the JSON format is currently unstable (thus the temporary
+ \cb{-v0.1} suffix).
Note that because it's possible to end up with multiple dumps (for
example, by specifying the \cb{--dump-scope} and/or \cb{--dump-target}
@@ -981,7 +981,7 @@ namespace build2
The order in which default options files are loaded is traced at the
verbosity level 3 (\cb{-V} option) or higher.
- \h|JSON OUTPUT|
+ \h#json-output|JSON OUTPUT|
Commands that support the JSON output specify their formats as a
serialized representation of a C++ \cb{struct} or an array thereof. For