Merge commit '1e7f2ce643f9b2c7e07c7cec7f04bcf13b489668' into HEAD

1 files changed, 17 insertions, 1 deletions

diff --git a/rules/CC/proto/RULES b/rules/CC/proto/RULES
index e7a2f46..35e13e6 100644
--- a/rules/CC/proto/RULES
+++ b/rules/CC/proto/RULES
@@ -76,7 +76,23 @@
       ]
     , "HOST_ARCH":
       ["The architecture on which the build actions are carried out."]
-    , "DEBUG": ["Compute the debug-stage, needed for local debugging."]
+    , "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 debug"
+      , "fission, 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."
+      ]
     }
   , "imports":
     { "base-provides": ["./", "..", "defaults-base-provides"]