mbedtls/scripts/apidoc_full.sh

#!/bin/sh

# Generate doxygen documentation with a full config.h (this ensures that every
# available flag is documented, and avoids warnings about documentation
# without a corresponding #define).
#
# /!\ This must not be a Makefile target, as it would create a race condition
# when multiple targets are invoked in the same parallel build.
#
# Copyright (C) 2016, Arm Limited, All Rights Reserved
#
# This file is part of Mbed TLS (https://tls.mbed.org)

set -eu

CONFIG_H='include/mbedtls/config.h'

if [ -r $CONFIG_H ]; then :; else
    echo "$CONFIG_H not found" >&2
    exit 1
fi

CONFIG_BAK=${CONFIG_H}.bak
cp -p $CONFIG_H $CONFIG_BAK

scripts/config.pl realfull
make apidoc

mv $CONFIG_BAK $CONFIG_H
Add scripts/apidoc_full.sh This re-introduces the apidoc with full config.h, but hopefully with the race conditions and other issues that the previous implementation had. Adapt doxygen test script to use that new script, and also check for errors in addition to warnings while at it. 2016-01-12 14:17:52 +00:00			`#!/bin/sh`

			`# Generate doxygen documentation with a full config.h (this ensures that every`
			`# available flag is documented, and avoids warnings about documentation`
			`# without a corresponding #define).`
			`#`
			`# /!\ This must not be a Makefile target, as it would create a race condition`
			`# when multiple targets are invoked in the same parallel build.`
Add copyright dates to all scripts To find any files with a missing copyright declaration, use the following script: # ======================== #!/bin/sh # Find files with copyright declarations, and list their file extensions exts=$(grep -Ril --exclude-dir .git 'Copyright.Arm' \| sed ' s/.\./-name "./ s/$/"/ ' \| sort -u \| sed -n ' :l N $!bl s/\n/ -o /gp ') # Find files with file extensions that ususally include copyright extensions, # but don't include a copyright declaration themselves. eval "find -path './.git' -prune -o\ ! -path './tests/data_files/format_pkcs12.fmt'\ ! -path './programs/psa/psa_constant_names_generated.c'\ '(' $exts ')' -print" \| xargs grep -Li 'Copyright.Arm' # ======================== Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2020-05-25 22:33:31 +00:00			`#`
			`# Copyright (C) 2016, Arm Limited, All Rights Reserved`
			`#`
			`# This file is part of Mbed TLS (https://tls.mbed.org)`
Add scripts/apidoc_full.sh This re-introduces the apidoc with full config.h, but hopefully with the race conditions and other issues that the previous implementation had. Adapt doxygen test script to use that new script, and also check for errors in addition to warnings while at it. 2016-01-12 14:17:52 +00:00
			`set -eu`

			`CONFIG_H='include/mbedtls/config.h'`

			`if [ -r $CONFIG_H ]; then :; else`
			`echo "$CONFIG_H not found" >&2`
			`exit 1`
			`fi`

			`CONFIG_BAK=${CONFIG_H}.bak`
			`cp -p $CONFIG_H $CONFIG_BAK`

			`scripts/config.pl realfull`
			`make apidoc`

			`mv $CONFIG_BAK $CONFIG_H`