mbedtls/scripts/apidoc_full.sh

#!/bin/sh

# Generate doxygen documentation with a full mbedtls_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 The Mbed TLS Contributors
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later

set -eu

CONFIG_H='include/mbedtls/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.py 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 15:17:52 +01:00			`#!/bin/sh`

Rename config.h to mbedtls_config.h This commit was generated using the following script: # ======================== #!/bin/sh git ls-files \| grep -v '^ChangeLog' \| xargs sed -b -E -i ' s/((check\|crypto\|full\|mbedtls\|query)_config)\.h/\1\nh/g s/config\.h/mbedtls_config.h/g y/\n/./ ' mv include/mbedtls/config.h include/mbedtls/mbedtls_config.h # ======================== Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-05-28 09:42:25 +02:00			`# Generate doxygen documentation with a full mbedtls_config.h (this ensures that every`
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 15:17:52 +01:00			`# 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 missing copyright dates to scripts and sources 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 --exclude-dir 3rdparty\ --exclude-dir programs/fuzz 'Copyright.Arm' \| sed ' s/.\/// s/.\././ s/./-name "&"/ ' \| 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' -o -path './3rdparty' -o -path './programs/fuzz' ')' -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-26 00:33:31 +02:00			`#`
Update copyright notices to use Linux Foundation guidance As a result, the copyright of contributors other than Arm is now acknowledged, and the years of publishing are no longer tracked in the source files. Also remove the now-redundant lines declaring that the files are part of MbedTLS. This commit was generated using the following script: # ======================== #!/bin/sh # Find files find '(' -path './.git' -o -path './3rdparty' ')' -prune -o -type f -print \| xargs sed -bi ' # Replace copyright attribution line s/Copyright.Arm./Copyright The Mbed TLS Contributors/I # Remove redundant declaration and the preceding line $!N /This file is part of Mbed TLS/Id P D ' # ======================== Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2020-08-07 13:07:28 +02:00			`# Copyright The Mbed TLS Contributors`
update headers Signed-off-by: Dave Rodgman <dave.rodgman@arm.com> 2023-11-02 20:47:20 +01:00			`# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later`
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 15:17:52 +01:00
			`set -eu`

Rename config.h to mbedtls_config.h This commit was generated using the following script: # ======================== #!/bin/sh git ls-files \| grep -v '^ChangeLog' \| xargs sed -b -E -i ' s/((check\|crypto\|full\|mbedtls\|query)_config)\.h/\1\nh/g s/config\.h/mbedtls_config.h/g y/\n/./ ' mv include/mbedtls/config.h include/mbedtls/mbedtls_config.h # ======================== Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2021-05-28 09:42:25 +02:00			`CONFIG_H='include/mbedtls/mbedtls_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 15:17:52 +01:00
			`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`

Invoke config.py instead of config.pl git grep -Fl /config.pl \| xargs sed -i -e 's!/config\.pl!/config.py!g' Also: * Change one comment in include/mbedtls/check_config.h. * Change PERL to PYTHON in CMakeLists.txt. 2019-07-27 23:52:53 +02:00			`scripts/config.py realfull`
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 15:17:52 +01:00			`make apidoc`

			`mv $CONFIG_BAK $CONFIG_H`