summaryrefslogtreecommitdiff
path: root/proto
diff options
context:
space:
mode:
authorKlaus Aehlig <klaus.aehlig@huawei.com>2022-04-26 09:34:11 +0200
committerKlaus Aehlig <klaus.aehlig@huawei.com>2022-04-26 16:32:44 +0200
commitd5dfcc32ea3a024203518a3b118af127cfc5c672 (patch)
tree58f8010b9ea07d1980c2ba3265ec569f3553d178 /proto
parentcf6942ed6f8dc22209f8570faa39b3a6231f546f (diff)
downloadrules-cc-d5dfcc32ea3a024203518a3b118af127cfc5c672.tar.gz
Improve documenatation of our internal rules
In particular, document the result for the most important rules.
Diffstat (limited to 'proto')
-rw-r--r--proto/RULES30
1 files changed, 29 insertions, 1 deletions
diff --git a/proto/RULES b/proto/RULES
index b6ce000..74182a9 100644
--- a/proto/RULES
+++ b/proto/RULES
@@ -1,6 +1,34 @@
{ "library":
- { "target_fields": ["srcs", "deps"]
+ { "doc":
+ [ "A proto library as abtract data structure."
+ , ""
+ , "Such a libray does not produce any artifacts itself, but it can be"
+ , "used as a dependency for various language-specific rules."
+ ]
+ , "target_fields": ["srcs", "deps"]
, "string_fields": ["stage", "name", "service"]
+ , "field_doc":
+ { "srcs": ["The proto files for this library"]
+ , "deps": ["Any other proto library this library depends on"]
+ , "stage":
+ [ "The directory to stage the source files to."
+ , "Directory components are joined by \"/\"."
+ ]
+ , "name": ["The name of the (abstract) library."]
+ , "service":
+ [ "If non empty, generate a service library (with acces sto \"rpc\""
+ , "definitions) instead of a regular one."
+ ]
+ }
+ , "artifacts_doc": ["None"]
+ , "runfiles_doc": ["None"]
+ , "provides_doc":
+ { "proto":
+ [ "A list containing a single target-graph node with the defintion of"
+ , "this proto library. The node types generated are \"library\" and"
+ , "\"service library\"."
+ ]
+ }
, "expression":
{ "type": "let*"
, "bindings":