[PATCH] scripts: add additional git log capitalization checks

[PATCH] scripts: add additional git log capitalization checks

[Bruce Richardson]

Add API, HW, SW, FW and VMDq to list of words to capitalize properly.
Since VMDq is a bit unusual, add it as special case check so we can
print an error message giving the correct way to write it.

Signed-off-by: Bruce Richadson <bruce.richardson@intel.com>
---
 scripts/check-git-log.sh | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/scripts/check-git-log.sh b/scripts/check-git-log.sh
index 7d2c7ee..1dbf592 100755
--- a/scripts/check-git-log.sh
+++ b/scripts/check-git-log.sh
@@ -89,7 +89,9 @@ bad=$(echo "$headlines" | grep --color=always \
 bad=$(echo "$headlines" | grep -E --color=always \
 	-e '\<(rx|tx|RX|TX)\>' \
 	-e '\<[pv]f\>' \
+	-e '\<[hsf]w\>' \
 	-e '\<l[234]\>' \
+	-e ':.*\<api\>' \
 	-e ':.*\<dma\>' \
 	-e ':.*\<pci\>' \
 	-e ':.*\<mtu\>' \
@@ -106,6 +108,12 @@ bad=$(echo "$headlines" | grep -E --color=always \
 	| sed 's,^,\t,')
 [ -z "$bad" ] || printf "Wrong headline lowercase:\n$bad\n"
 
+# special case check for VMDq to give good error message
+bad=$(echo "$headlines" | grep -E --color=always \
+	-e '\<(vmdq|VMDQ)\>' \
+	| sed 's,^,\t,')
+[ -z "$bad" ] || printf "Wrong headline capitalization, use 'VMDq':\n$bad\n"
+
 # check headline length (60 max)
 bad=$(echo "$headlines" | awk 'length>60 {print}' | sed 's,^,\t,')
 [ -z "$bad" ] || printf "Headline too long:\n$bad\n"
-- 
2.5.5

[PATCH v2] scripts: add additional git log capitalization checks

[Bruce Richardson]

Add API, NUMA, HW, SW, FW and VMDq to list of words to capitalize properly.
Since VMDq is a bit unusual, add it as special case check so we can
print an error message giving the correct way to write it.

Signed-off-by: Bruce Richadson <bruce.richardson@intel.com>

---
v2: add NUMA to list
---
 scripts/check-git-log.sh | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/scripts/check-git-log.sh b/scripts/check-git-log.sh
index 7d2c7ee..0f2b4bc 100755
--- a/scripts/check-git-log.sh
+++ b/scripts/check-git-log.sh
@@ -89,11 +89,14 @@ bad=$(echo "$headlines" | grep --color=always \
 bad=$(echo "$headlines" | grep -E --color=always \
 	-e '\<(rx|tx|RX|TX)\>' \
 	-e '\<[pv]f\>' \
+	-e '\<[hsf]w\>' \
 	-e '\<l[234]\>' \
+	-e ':.*\<api\>' \
 	-e ':.*\<dma\>' \
 	-e ':.*\<pci\>' \
 	-e ':.*\<mtu\>' \
 	-e ':.*\<mac\>' \
+	-e ':.*\<numa\>' \
 	-e ':.*\<vlan\>' \
 	-e ':.*\<rss\>' \
 	-e ':.*\<freebsd\>' \
@@ -106,6 +109,12 @@ bad=$(echo "$headlines" | grep -E --color=always \
 	| sed 's,^,\t,')
 [ -z "$bad" ] || printf "Wrong headline lowercase:\n$bad\n"
 
+# special case check for VMDq to give good error message
+bad=$(echo "$headlines" | grep -E --color=always \
+	-e '\<(vmdq|VMDQ)\>' \
+	| sed 's,^,\t,')
+[ -z "$bad" ] || printf "Wrong headline capitalization, use 'VMDq':\n$bad\n"
+
 # check headline length (60 max)
 bad=$(echo "$headlines" | awk 'length>60 {print}' | sed 's,^,\t,')
 [ -z "$bad" ] || printf "Headline too long:\n$bad\n"
-- 
2.5.5

Re: [PATCH v2] scripts: add additional git log capitalization checks

[Thomas Monjalon]

2016-07-05 17:03, Bruce Richardson:
> Add API, NUMA, HW, SW, FW and VMDq to list of words to capitalize properly.
> Since VMDq is a bit unusual, add it as special case check so we can
> print an error message giving the correct way to write it.
> 
> Signed-off-by: Bruce Richadson <bruce.richardson@intel.com>

Applied, thanks