From 8f0e34277635b1896de0f09fdcfadc0b73af3efa Mon Sep 17 00:00:00 2001
From: Klaus Aehlig <klaus.aehlig@huawei.com>
Date: Thu, 8 May 2025 10:16:25 +0200
Subject: rules: Allow all false values to disable DEBUG

While activating DEBUG requires setting it to a non-empty map,
providing information on whether and how debugg fission should be
used, we should still allow any logically false value (rather than
just null) to disable a debug build in order to make it easier for
the user to explicitly disable debugging.

Also adopt and fix the documentation strings.
---
 CC/RULES | 43 +++++++++++++++++++++++--------------------
 1 file changed, 23 insertions(+), 20 deletions(-)

(limited to 'CC/RULES')

diff --git a/CC/RULES b/CC/RULES
index a6c775c..a8cce27 100644
--- a/CC/RULES
+++ b/CC/RULES
@@ -110,21 +110,8 @@
       ["The architecture on which the build actions are carried out."]
     , "TARGET_ARCH": ["The architecture for which to build."]
     , "DEBUG":
-      [ "Map configuring the debug-stage, needed for local debugging."
-      , "If non-empty, debug mode is enabled."
-      , ""
-      , "The key \"USE_DEBUG_FISSION\" expects a flag which enables the debug"
-      , "fission mode, but does not add any flags. Explicitly setting it to a"
-      , "false value is needed to enable regular debug mode."
-      , "The key \"FISSION_CONFIG\" expects a map configuring debug fission."
-      , " - subkey \"USE_SPLIT_DWARF\" expects a flag that, if true, adds the"
-      , "-gsplit-dwarf compile flag."
-      , " - subkey \"DWARF_VERSION\" expects a string that adds the"
-      , "-gdwarf-<value> compile flag."
-      , " - subkey \"USE_GDB_INDEX\" expects a flag that, if true, adds the"
-      , "-Wl,--gdb-index linker flag."
-      , " - subkey \"USE_DEBUG_TYPES_SECTION\" expects a flag that, if true,"
-      , "adds the -fdebug-types-section compile flag."
+      [ "If logically true (typically, a non-empty map), use debug-related"
+      , "options, otherwise not."
       ]
     }
   , "imports":
@@ -604,8 +591,9 @@
       ]
     , "ENV": ["The environment for any action generated."]
     , "DEBUG":
-      [ "Map configuring the debug-stage, needed for local debugging."
-      , "If non-empty, debug mode is enabled."
+      [ "Either a logically false value to disable debugging, or a non-empty"
+      , "map to enable debugging. If debugging is enabled, the following values"
+      , "of the map are used."
       , ""
       , "The key \"USE_DEBUG_FISSION\" expects a flag which enables the debug"
       , "fission mode, but does not add any flags. Explicitly setting it to a"
@@ -663,6 +651,13 @@
     { "type": "let*"
     , "bindings":
       [ ["name", {"type": "join", "$1": {"type": "FIELD", "name": "name"}}]
+      , [ "DEBUG"
+        , { "type": "if"
+          , "cond": {"type": "var", "name": "DEBUG"}
+          , "then": {"type": "var", "name": "DEBUG"}
+          , "else": {"type": "empty_map"}
+          }
+        ]
       , ["pure C", {"type": "FIELD", "name": "pure C"}]
       , [ "cflags"
         , { "type": "++"
@@ -780,7 +775,7 @@
       , "with \"/\"."
       ]
     , "pure C":
-      [ "If non-empty, compile as C sources rathter than C++ sources."
+      [ "If non-empty, compile as C sources rather than C++ sources."
       , "In particular, CC is used to compile rather than CXX"
       ]
     , "private-defines":
@@ -828,8 +823,9 @@
       ]
     , "ENV": ["The environment for any action generated."]
     , "DEBUG":
-      [ "Map configuring the debug-stage, needed for local debugging."
-      , "If non-empty, debug mode is enabled."
+      [ "Either a logically false value to disable debugging, or a non-empty"
+      , "map to enable debugging. If debugging is enabled, the following values"
+      , "of the map are used."
       , ""
       , "The key \"USE_DEBUG_FISSION\" expects a flag which enables the debug"
       , "fission mode, but does not add any flags. Explicitly setting it to a"
@@ -879,6 +875,13 @@
           , "$1": {"type": "join", "$1": {"type": "FIELD", "name": "name"}}
           }
         ]
+      , [ "DEBUG"
+        , { "type": "if"
+          , "cond": {"type": "var", "name": "DEBUG"}
+          , "then": {"type": "var", "name": "DEBUG"}
+          , "else": {"type": "empty_map"}
+          }
+        ]
       , ["pure C", {"type": "FIELD", "name": "pure C"}]
       , [ "stage"
         , { "type": "join"
-- 
cgit v1.2.3