From 870efd45868aeed7e0c088bb3edd753bf52a299f Mon Sep 17 00:00:00 2001 From: Klaus Aehlig Date: Tue, 11 Apr 2023 12:37:31 +0200 Subject: README.md: document noticeable configuration variables --- etc/generate-doc.sh | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'etc/generate-doc.sh') 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" -- cgit v1.2.3