Add documentation

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2021-08-05 15:13:57 +02:00
parent 86f6129067
commit 91e890e2fc

View file

@ -1,5 +1,18 @@
#!/bin/sh #!/bin/sh
DEFAULT_OUTPUT_FILE=programs/test/cpp_dummy_build.cpp
if [ "$1" = "--help" ]; then
cat <<EOF
Usage: $0 [OUTPUT]
Generate a C++ dummy build program that includes all the headers.
OUTPUT defaults to "programs/test/cpp_dummy_build.cpp".
Run this program from the root of an Mbed TLS directory tree or from
its "programs" or "programs/test" subdirectory.
EOF
exit
fi
# Copyright The Mbed TLS Contributors # Copyright The Mbed TLS Contributors
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# #
@ -83,4 +96,4 @@ else
exit 3 exit 3
fi fi
print_cpp >"${1:-programs/test/cpp_dummy_build.cpp}" print_cpp >"${1:-$DEFAULT_OUTPUT_FILE}"