summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul Cristian Sarbu <paul.cristian.sarbu@huawei.com>2025-04-23 12:11:42 +0200
committerPaul Cristian Sarbu <paul.cristian.sarbu@huawei.com>2025-04-23 13:05:10 +0200
commit2d175e0354feca33a64488fd9ceffac0cf0b2fc8 (patch)
tree9db30707b0b2e7d5b619080b7dc930cdd2dc78e0 /doc
parenta045db67a4b9e388e66dc80f33e8548465546fc4 (diff)
downloadjustbuild-2d175e0354feca33a64488fd9ceffac0cf0b2fc8.tar.gz
tutorial: Update DEBUG config variable to map
In preparation for the rule changes, to avoid introducing false positives during future bisections.
Diffstat (limited to 'doc')
-rw-r--r--doc/tutorial/debugging.md12
-rw-r--r--doc/tutorial/proto.md6
2 files changed, 5 insertions, 13 deletions
diff --git a/doc/tutorial/debugging.md b/doc/tutorial/debugging.md
index d59f312b..eae070b6 100644
--- a/doc/tutorial/debugging.md
+++ b/doc/tutorial/debugging.md
@@ -75,19 +75,15 @@ need to add a new target, configured in debug mode.
, "helloworld-debug":
{ "type": "configure"
, "target": "helloworld"
- , "config":
- { "type": "let*"
- , "bindings": [["DEBUG", true]]
- , "body": {"type": "env", "vars": ["DEBUG"]}
- }
+ , "config": {"type": "'", "$1": {"DEBUG": {"USE_DEBUG_FISSION": false}}}
}
...
```
This describes the debug version of *hello-world*, configured by setting the
-`"DEBUG"` flag, which in turn will instruct the updated toolchain defaults,
-which now honor the `"DEBUG"` argument, to compile all actions with the `"-g"`
-flag.
+`"DEBUG"` map to enable regular (non-fission) debug mode, which in turn will
+instruct the updated toolchain defaults, which honor the `"DEBUG"` argument, to
+compile all actions with the `"-g"` flag.
To actually collect the artifacts needed to run the debugger, we use the
`["CC", "install-with-deps"]` rule, contained in the `rules-cc` repository.
diff --git a/doc/tutorial/proto.md b/doc/tutorial/proto.md
index 1eac9c13..62e084f7 100644
--- a/doc/tutorial/proto.md
+++ b/doc/tutorial/proto.md
@@ -560,11 +560,7 @@ in the chapter on [*Debugging*](./hello-world.md)).
, "list_people debug":
{ "type": "configure"
, "target": "list_people"
- , "config":
- { "type": "let*"
- , "bindings": [["DEBUG", true]]
- , "body": {"type": "env", "vars": ["DEBUG"]}
- }
+ , "config": {"type": "'", "$1": {"DEBUG": {"USE_DEBUG_FISSION": false}}}
}
, "list_people debug staged":
{ "type": ["@", "rules", "CC", "install-with-deps"]