From: Thomas Monjalon <thomas@monjalon.net>
To: dev@dpdk.org
Cc: john.mcnamara@intel.com, marko.kovacevic@intel.com,
Arnon Warshavsky <arnon@qwilt.com>
Subject: [dpdk-dev] [PATCH v2] devtools: check wrong svg include in guides
Date: Wed, 31 Oct 2018 17:28:42 +0100 [thread overview]
Message-ID: <20181031162842.19431-1-thomas@monjalon.net> (raw)
In-Reply-To: <20181031110548.31184-1-thomas@monjalon.net>
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 <thomas@monjalon.net>
Signed-off-by: Arnon Warshavsky <arnon@qwilt.com>
PS: the warning contains the regex. May it be improved?
Warning in /doc/guides/nics/mvpp2.rst:
are you sure you want to add the following:
::[[:space:]]*[^[:space:]]*\.svg
Cc: Arnon Warshavsky <arnon@qwilt.com>
---
devtools/checkpatches.sh | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index bf3114f95..fb9e9f76d 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -43,13 +43,21 @@ print_usage () {
END_OF_HELP
}
-check_forbidden_additions() {
+check_forbidden_additions() { # <patch>
# 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 () { # <patch> <commit> <title>
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.19.0
next prev parent reply other threads:[~2018-10-31 16:29 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-31 11:05 [dpdk-dev] [PATCH] devtools: check wrong svg include in patches Thomas Monjalon
2018-10-31 15:46 ` Arnon Warshavsky
2018-10-31 15:51 ` Thomas Monjalon
2018-10-31 15:55 ` Arnon Warshavsky
2018-10-31 16:28 ` Thomas Monjalon [this message]
2018-11-01 6:45 ` [dpdk-dev] [PATCH v2] devtools: check wrong svg include in guides Arnon Warshavsky
2018-11-01 9:27 ` Thomas Monjalon
2018-11-01 9:29 ` Arnon Warshavsky
2018-11-01 13:59 ` Arnon Warshavsky
2018-11-01 14:10 ` Thomas Monjalon
2018-11-01 21:25 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20181031162842.19431-1-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=arnon@qwilt.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).