Improve documentation

Signed-off-by: Gilles Peskine <[email protected]>
This commit is contained in:
Gilles Peskine
2025-09-23 16:26:04 +02:00
parent 48a1cbc930
commit 0acab5c3c6
+7 -3
View File
@@ -9,9 +9,10 @@ Record information for the git commit COMMIT (tag, sha or any other refspec).
Store the list of config options and internal macros in file names indicating Store the list of config options and internal macros in file names indicating
the version VERSION. the version VERSION.
-C DIR Top-level directory where the git commit can be found -C DIR Top-level directory where the git commit can be found.
(default: $project_root) Default: $project_root
-o DIR Directory for the output files (default: $history_dir) -o DIR Directory for the output files. It must exist.
Default: $history_dir
EOF EOF
} }
@@ -59,6 +60,9 @@ fi
temp_file=$(mktemp) temp_file=$(mktemp)
trap 'rm -f "$temp_file"' EXIT INT TERM trap 'rm -f "$temp_file"' EXIT INT TERM
## collect_macros VARIANT FILENAME...
## Find the macros defined in the given files. Save the result in
## $history_dir/config-VARIANT-*.txt.
collect_macros () { collect_macros () {
output_file="$history_dir/config-$1-$product-$version.txt" output_file="$history_dir/config-$1-$product-$version.txt"
shift shift