mbedtls/tests/scripts/doxygen.sh

#!/bin/sh

# Make sure the doxygen documentation builds without warnings
#
# Copyright The Mbed TLS Contributors
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later

# Abort on errors (and uninitialised variables)
set -eu

if [ -d library -a -d include -a -d tests ]; then :; else
    echo "Must be run from Mbed TLS root" >&2
    exit 1
fi

if scripts/apidoc_full.sh > doc.out 2>doc.err; then :; else
    cat doc.err
    echo "FAIL" >&2
    exit 1;
fi

cat doc.out doc.err | \
    grep -v "warning: ignoring unsupported tag" \
    > doc.filtered

if grep -E "(warning|error):" doc.filtered; then
    echo "FAIL" >&2
    exit 1;
fi

make apidoc_clean
rm -f doc.out doc.err doc.filtered
Add test script for doxygen warnings 2016-01-04 15:49:09 +00:00			`#!/bin/sh`

			`# Make sure the doxygen documentation builds without warnings`
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-25 22:33:31 +00: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 11:07:28 +00:00			`# Copyright The Mbed TLS Contributors`
update headers Signed-off-by: Dave Rodgman <dave.rodgman@arm.com> 2023-11-02 19:47:20 +00:00			`# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later`
Add test script for doxygen warnings 2016-01-04 15:49:09 +00:00
Fix typos Signed-off-by: Jan Bruckner <jan@janbruckner.de> 2023-02-06 11:54:53 +00:00			`# Abort on errors (and uninitialised variables)`
Add test script for doxygen warnings 2016-01-04 15:49:09 +00:00			`set -eu`

			`if [ -d library -a -d include -a -d tests ]; then :; else`
Update spelling "mbed TLS" to "Mbed TLS" The official spelling of the trade mark changed from all-lowercase "mbed" to normal proper noun capitalization "Mbed" a few years ago. We've been using the new spelling in new text but still have the old spelling in a lot of text. This commit updates most occurrences of "mbed TLS": ``` sed -i -e 's/mbed TLS/Mbed TLS/g' $(git ls-files ':!ChangeLog' ':!tests/data_files/*' ':!tests/suites/.data' ':!programs/x509/' ':!configs/tfm') ``` Justification for the omissions: * `ChangeLog`: historical text. * `test/data_files/*`, `tests/suites/.data`, `programs/x509/`: many occurrences are significant names in certificates and such. Changing the spelling would invalidate many signatures and tests. `configs/tfm*`: this is an imported file. We'll follow the upstream updates. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com> 2023-08-03 15:45:20 +00:00			`echo "Must be run from Mbed TLS root" >&2`
Add test script for doxygen warnings 2016-01-04 15:49:09 +00:00			`exit 1`
			`fi`

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			`if scripts/apidoc_full.sh > doc.out 2>doc.err; then :; else`
Add test script for doxygen warnings 2016-01-04 15:49:09 +00:00			`cat doc.err`
			`echo "FAIL" >&2`
			`exit 1;`
			`fi`

Exclude some warnings from the doxygen test Apparently travis has an old version of doxygen that doesn't know all tags in our config. That's not something we care about, we only want to know about warnings in our doxygen content 2016-01-08 15:47:33 +00:00			`cat doc.out doc.err \| \`
			`grep -v "warning: ignoring unsupported tag" \`
			`> doc.filtered`

Use `grep -E` instead of `egrep` `egrep` has been deprecated in GNU grep since 2007, and since 3.8 it emits obsolescence warnings: https://git.savannah.gnu.org/cgit/grep.git/commit/?id=a9515624709865d480e3142fd959bccd1c9372d1 Signed-off-by: Ville Skyttä <ville.skytta@iki.fi> 2023-01-01 16:19:49 +00:00			`if grep -E "(warning\|error):" doc.filtered; then`
Add test script for doxygen warnings 2016-01-04 15:49:09 +00:00			`echo "FAIL" >&2`
			`exit 1;`
			`fi`

			`make apidoc_clean`
Exclude some warnings from the doxygen test Apparently travis has an old version of doxygen that doesn't know all tags in our config. That's not something we care about, we only want to know about warnings in our doxygen content 2016-01-08 15:47:33 +00:00			`rm -f doc.out doc.err doc.filtered`