summaryrefslogtreecommitdiff
path: root/CC
diff options
context:
space:
mode:
authorKlaus Aehlig <klaus.aehlig@huawei.com>2023-08-21 09:00:00 +0200
committerKlaus Aehlig <klaus.aehlig@huawei.com>2023-08-21 10:29:52 +0200
commitb539d47269b7c3592879056f543301d16595d75b (patch)
treea8cbae936eef61b6c7b15e29ec878292092790c7 /CC
parent78540814ad421bc02a4f6c7396d81c38c95ef503 (diff)
downloadrules-cc-b539d47269b7c3592879056f543301d16595d75b.tar.gz
rules: Add documentation for the implict dependencies
Diffstat (limited to 'CC')
-rw-r--r--CC/RULES2
-rw-r--r--CC/auto/RULES2
-rw-r--r--CC/pkgconfig/RULES1
-rw-r--r--CC/test/RULES10
4 files changed, 15 insertions, 0 deletions
diff --git a/CC/RULES b/CC/RULES
index c30aaee..bea41d2 100644
--- a/CC/RULES
+++ b/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/CC/auto/RULES b/CC/auto/RULES
index 860db01..b1419fb 100644
--- a/CC/auto/RULES
+++ b/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/CC/pkgconfig/RULES b/CC/pkgconfig/RULES
index a6f6ce8..4424cb2 100644
--- a/CC/pkgconfig/RULES
+++ b/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/CC/test/RULES b/CC/test/RULES
index af413a9..e09d08e 100644
--- a/CC/test/RULES
+++ b/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."]