RIOT/dist/tools/doccheck/check.sh

#!/bin/sh

# Copyright 2014 Oliver Hahm <oliver.hahm@inria.fr>
#
# This file is subject to the terms and conditions of the GNU Lesser
# General Public License v2.1. See the file LICENSE in the top level
# directory for more details.

RIOTBASE=$(readlink -f "$(dirname $(realpath $0))/../../..")

ERRORS=$(make -C "${RIOTBASE}" doc 2>&1 | \
            grep '.*warning' | \
            sed "s#${PWD}/\([^:]*\)#\1#g")

if [ -n "${ERRORS}" ]
then
    echo "ERROR: Doxygen generates the following warnings:"
    echo "${ERRORS}"
    exit 2
else
    exit 0
fi
travis: check for doxygen warnings This introduces a script that will check for doxygen warnings in newly committed or edited files. 2014-11-28 02:09:42 +01:00			`#!/bin/sh`

travis: added doxygen check script to travis config 2014-11-28 02:12:19 +01:00			`# Copyright 2014 Oliver Hahm <oliver.hahm@inria.fr>`
			`#`
			`# This file is subject to the terms and conditions of the GNU Lesser`
			`# General Public License v2.1. See the file LICENSE in the top level`
			`# directory for more details.`

doccheck: actually show warning, not just file 2017-04-25 21:00:21 +02:00			`RIOTBASE=$(readlink -f "$(dirname $(realpath $0))/../../..")`

docheck: make doccheck executable from any directory The doccheck script reports reports a false positive when executed from any directory but `RIOTBASE`. With this fix, `make doc` changes into the currently unused `RIOTBASE` variable. This is an alternative approach to #7217, which removes this variable, but keeps the false positive aspect of the script untouched. 2017-12-07 11:00:12 +01:00			`ERRORS=$(make -C "${RIOTBASE}" doc 2>&1 \| \`
			`grep '.*warning' \| \`
			`sed "s#${PWD}/\([^:]*\)#\1#g")`
travis: check for doxygen warnings This introduces a script that will check for doxygen warnings in newly committed or edited files. 2014-11-28 02:09:42 +01:00
travis: added doxygen check script to travis config 2014-11-28 02:12:19 +01:00			`if [ -n "${ERRORS}" ]`
travis: check for doxygen warnings This introduces a script that will check for doxygen warnings in newly committed or edited files. 2014-11-28 02:09:42 +01:00			`then`
doccheck: actually show warning, not just file 2017-04-25 21:00:21 +02:00			`echo "ERROR: Doxygen generates the following warnings:"`
travis: added doxygen check script to travis config 2014-11-28 02:12:19 +01:00			`echo "${ERRORS}"`
travis: check for doxygen warnings This introduces a script that will check for doxygen warnings in newly committed or edited files. 2014-11-28 02:09:42 +01:00			`exit 2`
			`else`
			`exit 0`
			`fi`