summaryrefslogtreecommitdiff
path: root/CC/test
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 /CC/test
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 'CC/test')
-rw-r--r--CC/test/RULES13
1 files changed, 13 insertions, 0 deletions
diff --git a/CC/test/RULES b/CC/test/RULES
index fc3ab97..50d0dce 100644
--- a/CC/test/RULES
+++ b/CC/test/RULES
@@ -43,6 +43,19 @@
, "command line for running the test binary."
]
}
+ , "artifacts_doc":
+ [ "result: the result of this test (\"PASS\" or \"FAIL\"); useful for"
+ , " generating test reports."
+ , "stdout/stderr: Any output the invocation of the test binary produced on"
+ , " the respective file descriptor"
+ , "time-start/time-stop: The time (decimally coded) in seconds since the"
+ , " epoch when the test invocation started and ended."
+ ]
+ , "runfiles_doc":
+ [ "A tree consisting of the artifacts staged at the name of the test."
+ , "As the built-in \"install\" rule only takes the runfiles of its \"deps\""
+ , "argument, this gives an easy way of defining test suites."
+ ]
, "imports":
{ "artifacts": ["./", "../..", "field_artifacts"]
, "compile-deps": ["./", "..", "compile-deps"]