riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

dist/tools/doccheck: add exclude file for warnings and use it

Browse Source 
This is purely to finally unblock RIOT-OS/riotdocker#104, but may also
be useful to add future exclude patterns.

Exclude file was generated using

```sh
make doc 2> dist/tools/doccheck/exclude_patterns_base
grep "^${PWD}" dist/tools/doccheck/exclude_patterns_base | \
    sed -E -e "s#^${PWD}/(.*:)([0-9]+): #\1DIGITS_MAGIC: #" \
           -e 's/[]\\.$*{}|+?()[^-]/\\&/g' \
           -e 's/:DIGITS_MAGIC:/:[0-9]+:/' \
        > dist/tools/doccheck/exclude_patterns
rm dist/tools/doccheck/exclude_patterns_base
```
This commit is contained in:
Martine Lenders 2021-08-26 13:39:37 +02:00
parent da140c251a
commit acdcaf16a5
No known key found for this signature in database
GPG Key ID: 2134D77A5336DD80
2 changed files with 14625 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
dist/tools/doccheck/check.sh vendored
View File

@ -8,7 +8,9 @@
# General Public License v2.1. See the file LICENSE in the top level
# directory for more details.
RIOTBASE="$(cd $(dirname $0)/../../..; pwd)"
SCRIPTDIR="$(cd $(dirname "$0"); pwd)"
RIOTBASE="$(cd "${SCRIPTDIR}"/../../..; pwd)"
EXCLUDE_PATTERN_FILE="${SCRIPTDIR}/exclude_patterns"
. ${RIOTBASE}/dist/tools/ci/github_annotate.sh
@ -24,7 +26,7 @@ else
CRESET=
fi
DOXY_OUTPUT=$(make -C "${RIOTBASE}" doc 2>&1)
DOXY_OUTPUT=$(make -C "${RIOTBASE}" doc 2>&1 | grep -Evf "${EXCLUDE_PATTERN_FILE}")
DOXY_ERRCODE=$?
RESULT=0

14621
dist/tools/doccheck/exclude_patterns vendored Normal file
View File

File diff suppressed because it is too large Load Diff