From d5dfcc32ea3a024203518a3b118af127cfc5c672 Mon Sep 17 00:00:00 2001
From: Klaus Aehlig <klaus.aehlig@huawei.com>
Date: Tue, 26 Apr 2022 09:34:11 +0200
Subject: Improve documenatation of our internal rules

In particular, document the result for the most important
rules.
---
 CC/RULES | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'CC/RULES')

diff --git a/CC/RULES b/CC/RULES
index 01aa634..cfe1ae3 100644
--- a/CC/RULES
+++ b/CC/RULES
@@ -115,6 +115,8 @@
       , "Path segments are joined with \"/\"."
       ]
     }
+  , "artifacts_doc": ["The single tree artifact staged to the given location"]
+  , "runfiles_doc": ["Same as artifacts"]
   , "expression":
     { "type": "let*"
     , "bindings":
@@ -227,6 +229,23 @@
       , "choice"
       ]
     }
+  , "artifacts_doc":
+    ["The actual library (libname.a) staged in the specified directory"]
+  , "runfiles_doc": ["The public headers of this library"]
+  , "provides_doc":
+    { "compile-deps":
+      [ "Map of artifacts specifying any additional files that, besides the runfiles,"
+      , "have to be present in compile actions of targets depending on this library"
+      ]
+    , "link-deps":
+      [ "Map of artifacts specifying any additional files that, besides the artifacts,"
+      , "have to be present in a link actions of targets depending on this library"
+      ]
+    , "link-args":
+      [ "List of strings that have to be added to the command line for linking actions"
+      , "in targets depending on on this library"
+      ]
+    }
   , "anonymous":
     { "proto-deps":
       { "target": "proto"
@@ -372,6 +391,8 @@
       , "taken from the [\"CC\", \"defaults\"] target"
       ]
     }
+  , "artifacts_doc": ["The final binary, staged to the given directory"]
+  , "runfiles_doc": ["None"]
   , "anonymous":
     { "proto-deps":
       { "target": "proto"
-- 
cgit v1.2.3