rules: Add documentation for the implict dependencies

6 files changed, 26 insertions, 0 deletions

diff --git a/rules/CC/RULES b/rules/CC/RULES
index c30aaee1..bea41d27 100644
--- a/rules/CC/RULES
+++ b/rules/CC/RULES
@@ -397,6 +397,7 @@
       [ "Name to use for pkg-config files. If this field is empty, the field"
       , "\"name\" is used instead."
       ]
+    , "defaults": ["The C/C++ toolchain to use"]
     }
   , "config_doc":
     { "CC":
@@ -596,6 +597,7 @@
       , "duplicate work will be carried out, even if the same proto library"
       , "is used at various places)."
       ]
+    , "defaults": ["The C/C++ toolchain to use"]
     }
   , "config_doc":
     { "CC":
diff --git a/rules/CC/auto/RULES b/rules/CC/auto/RULES
index 860db01c..b1419fb8 100644
--- a/rules/CC/auto/RULES
+++ b/rules/CC/auto/RULES
@@ -22,6 +22,7 @@
       , "include path. Useful for providing additional header files to values"
       , "given in \"have_{cfile,cxxfile,ctype,cxxtype,csymbol,cxxsymbol}\"."
       ]
+    , "defaults": ["The C/C++ toolchain to use"]
     }
   , "config_doc":
     { "CC":
@@ -1032,6 +1033,7 @@
       , "defined in the config field \"defines\"."
       ]
     , "@only": ["If set, only replace @VAR@ and not ${VAR}"]
+    , "runner": ["The program generating the header file from the template."]
     }
   , "config_doc":
     { "defines":
diff --git a/rules/CC/pkgconfig/RULES b/rules/CC/pkgconfig/RULES
index a6f6ce84..4424cb2f 100644
--- a/rules/CC/pkgconfig/RULES
+++ b/rules/CC/pkgconfig/RULES
@@ -10,6 +10,7 @@
       , "\"--static\"), appended to the config variable \"PKG_CONFIG_ARGS\"."
       ]
     , "stage": ["The stage of the internally created flag files."]
+    , "defaults": ["The C/C++ toolchain to use"]
     }
   , "config_doc":
     { "PKG_CONFIG_ARGS":
diff --git a/rules/CC/test/RULES b/rules/CC/test/RULES
index af413a9b..e09d08eb 100644
--- a/rules/CC/test/RULES
+++ b/rules/CC/test/RULES
@@ -70,6 +70,16 @@
       , "Individual directory components are joined with \"/\"."
       ]
     , "data": ["Any files the test binary needs access to when running"]
+    , "defaults": ["The C/C++ toolchain to use"]
+    , "runner":
+      [ "The test runner which starts the actual test binrary after providing"
+      , "the respective environment. The runner also takes care of capturing"
+      , "stdout/stderr and timing information."
+      ]
+    , "summarizer":
+      [ "Tool to aggregate the results of individual test runs (for flakyness"
+      , "detection) to an overall test result."
+      ]
     }
   , "config_doc":
     { "CC": ["The name of the C compiler to be used."]
diff --git a/rules/patch/RULES b/rules/patch/RULES
index 712a4877..6f4471ca 100644
--- a/rules/patch/RULES
+++ b/rules/patch/RULES
@@ -151,6 +151,7 @@
       [ "The single source file to patch, typically an explicit file reference."
       ]
     , "patch": ["The patch to apply."]
+    , "patch-defaults": ["The patch binary (and toolchain) to use"]
     }
   , "artifacts_doc":
     ["The patched file, staged to the position the of the original file"]
diff --git a/rules/shell/test/RULES b/rules/shell/test/RULES
index c4f85695..44acb002 100644
--- a/rules/shell/test/RULES
+++ b/rules/shell/test/RULES
@@ -39,6 +39,16 @@
       [ "Any targets that should be staged (with artifacts and runfiles) into"
       , "the tests working directory"
       ]
+    , "runner":
+      [ "The test runner which starts the actual test script after providing"
+      , "the respective environment. The runner also takes care of capturing"
+      , "stdout/stderr, timing information, and ensure the presence of the"
+      , "files to keep even if the script failed to produce them."
+      ]
+    , "summarizer":
+      [ "Tool to aggregate the results of individual test runs (for flakyness"
+      , "detection) to an overall test result."
+      ]
     }
   , "config_doc":
     { "RUNS_PER_TEST":