summaryrefslogtreecommitdiff
path: root/etc/README.template.md
diff options
context:
space:
mode:
authorKlaus Aehlig <klaus.aehlig@huawei.com>2023-04-11 12:37:31 +0200
committerKlaus Aehlig <klaus.aehlig@huawei.com>2023-04-11 15:46:35 +0200
commit870efd45868aeed7e0c088bb3edd753bf52a299f (patch)
tree5caceb0dbb992df3f926e4144c3afd90ea5ac11f /etc/README.template.md
parenta5facd165432418b5d1758d3f3377ee49a6f30b3 (diff)
downloadrules-cc-870efd45868aeed7e0c088bb3edd753bf52a299f.tar.gz
README.md: document noticeable configuration variables
Diffstat (limited to 'etc/README.template.md')
-rw-r--r--etc/README.template.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/etc/README.template.md b/etc/README.template.md
index f53a94c..0ad4d9f 100644
--- a/etc/README.template.md
+++ b/etc/README.template.md
@@ -36,3 +36,9 @@ For interoperability with CMake projects, see
- [being consumed by CMake](./doc/being-consumed-by-cmake.org)
## Rule Documentation
+
+In this documentation, the standard configuration variables
+`"AR"`, `"CC"`, `"CXX"`, `"CFLAGS"`, `"CXXFLAGS"`,`"LDFLAGS"`,
+`"ADD_CFLAGS"`, `"ADD_CXXFLAGS"`, `"ADD_LDFLAGS"`, `"ENV"`,
+`"BUILD_POSITION_INDEPENDENT"` are ommitted.
+