From 4d4c612e6a3021c9d0faa7768919c588021af230 Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Wed, 31 Oct 2018 17:28:42 +0100 Subject: [PATCH] devtools: check wrong svg include in guides Including svg files with the svg extension is a common mistake: .. figure:: example.svg must be .. figure:: example.* So it will work also when building pdf doc with figures converted to png files. A check is added in checkpatches.sh. Signed-off-by: Thomas Monjalon Signed-off-by: Arnon Warshavsky --- devtools/checkpatches.sh | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh index bf3114f954..fb9e9f76de 100755 --- a/devtools/checkpatches.sh +++ b/devtools/checkpatches.sh @@ -43,13 +43,21 @@ print_usage () { END_OF_HELP } -check_forbidden_additions() { +check_forbidden_additions() { # # refrain from new additions of rte_panic() and rte_exit() # multiple folders and expressions are separated by spaces awk -v FOLDERS="lib drivers" \ -v EXPRESSIONS="rte_panic\\\( rte_exit\\\(" \ -v RET_ON_FAIL=1 \ - -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk - + -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \ + "$1" + # svg figures must be included with wildcard extension + # because of png conversion for pdf docs + awk -v FOLDERS='doc' \ + -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \ + -v RET_ON_FAIL=1 \ + -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \ + "$1" } number=0 @@ -115,7 +123,7 @@ check () { # fi ! $verbose || printf '\nChecking forbidden tokens additions:\n' - report=$(check_forbidden_additions <"$tmpinput") + report=$(check_forbidden_additions "$tmpinput") if [ $? -ne 0 ] ; then $headline_printed || print_headline "$3" printf '%s\n' "$report" -- 2.20.1