diff options
| author | Klaus Aehlig <klaus.aehlig@huawei.com> | 2023-04-11 12:37:31 +0200 |
|---|---|---|
| committer | Klaus Aehlig <klaus.aehlig@huawei.com> | 2023-04-11 15:46:35 +0200 |
| commit | 870efd45868aeed7e0c088bb3edd753bf52a299f (patch) | |
| tree | 5caceb0dbb992df3f926e4144c3afd90ea5ac11f /etc | |
| parent | a5facd165432418b5d1758d3f3377ee49a6f30b3 (diff) | |
| download | rules-cc-870efd45868aeed7e0c088bb3edd753bf52a299f.tar.gz | |
README.md: document noticeable configuration variables
Diffstat (limited to 'etc')
| -rw-r--r-- | etc/README.template.md | 6 | ||||
| -rwxr-xr-x | etc/generate-doc.sh | 10 |
2 files changed, 16 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. + diff --git a/etc/generate-doc.sh b/etc/generate-doc.sh index 5a0f3de..ca8e7d6 100755 --- a/etc/generate-doc.sh +++ b/etc/generate-doc.sh @@ -27,6 +27,7 @@ doc2md() { local RULE_DOC="$(just-mr --main "$MAIN" describe --rule --json "$MODULE" "$RULE")" local DOC="$(echo "$RULE_DOC" | jq -r '.doc')" local FIELD_DOC="$(echo "$RULE_DOC" | jq -r '.field_doc')" + local CONFIG_DOC="$(echo "$RULE_DOC" | jq -r '.config_doc | delpaths([["AR"], ["CC"], ["CXX"], ["CFLAGS"], ["CXXFLAGS"],["LDFLAGS"], ["ADD_CFLAGS"], ["ADD_CXXFLAGS"], ["ADD_LDFLAGS"], ["ENV"], ["BUILD_POSITION_INDEPENDENT"]])')" echo "### Rule \`[\"$MODULE\", \"$RULE\"]\`" echo @@ -40,6 +41,15 @@ doc2md() { | jq -r 'keys_unsorted[] as $k | "| \"\($k)\" | \(.[$k] | join(" ")) |"' \ | sed 's/\("[^"]*"\|\[[^]]*\]\|{[^}]*}\)/`\1`/g' echo + if [ "$(echo "$CONFIG_DOC" | jq -r 'length')" -gt 0 ] + then + echo "| Config variable | Description |" + echo "| --------------- | ----------- |" + echo "$CONFIG_DOC" \ + | jq -r 'keys_unsorted[] as $k | "| \"\($k)\" | \(.[$k] | join(" ")) |"' \ + | sed 's/\("[^"]*"\|\[[^]]*\]\|{[^}]*}\)/`\1`/g' + echo + fi } rm -f "$OUTFILE" |