[coreboot-gerrit] New patch to review for coreboot: util/lint: Add a lint tool to find non-ascii & unprintable chars

[Martin Roth (martinroth@google.com)]

Martin Roth (martinroth at google.com) just uploaded a new patch set to gerrit, which you can find at https://review.coreboot.org/15979

-gerrit

commit efd7bff6f9a89f3c060dfa440550b441b83d5ae3
Author: Martin Roth <martinroth at google.com>
Date:   Fri Jul 29 14:20:55 2016 -0600

    util/lint: Add a lint tool to find non-ascii & unprintable chars
    
    Change-Id: I40f7e61fd403cbad19cf0746e2017c53e7379bf8
    Signed-off-by: Martin Roth <martinroth at google.com>
---
 util/lint/lint-016-non-ascii | 45 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/util/lint/lint-016-non-ascii b/util/lint/lint-016-non-ascii
new file mode 100755
index 0000000..07717a6
--- /dev/null
+++ b/util/lint/lint-016-non-ascii
@@ -0,0 +1,45 @@
+#!/bin/sh
+# This file is part of the coreboot project.
+#
+# Copyright (C) 2016 Google Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# DESCR: Check for non-ascii and unprintable characters
+
+LC_ALL=C export LC_ALL
+
+INCLUDED_FILES='\.[chsS]$\|\.asl$\|\.cb$\|\.inc$\|Kconfig\|\.ld$|\.txt\|\.hex'
+EXCLUDED_DIRS='^payloads/\|^src/vendorcode/\|^Documentation/\|^build/\|^3rdparty/\|^\.git/\|^coreboot-builds/\|^util/nvidia/cbootimage'
+EXCLUDED_FILES='to-wiki/towiki\.sh$\|vga/vga_font\|video/font\|PDCurses.*x11'
+EXCLUDED_PHRASES='Intel®\|°C\|°F\|Athlon™\|Copyright.*©\|A-Za-zÀ-ÿ'
+EXCLUDED_NAMES='Gröger\|Züpke\|Kyösti\|Mälkki\|François\|Michał\|Mirosław\|Măgherușan\|Neuschäfer'
+
+# Use git ls-files if the code is in a git repo, otherwise use find.
+if [ -n "$(command -v git)" ] && [ -d .git ]; then
+	FIND_FILES="git ls-files"
+else
+	FIND_FILES="find . "
+fi
+
+# 1. Get the list of files to parse and send them through grep
+# 2. Find any characters that aren't TAB, or space (0x20) to ~ (0x7F)
+#    LF (0x10) isn't included, as it ends the grep line
+# 3. Remove common phrases and names that have been found
+# 4. Run the result through grep again to highlight the issues that were
+#    found.  Without this step, the characters can be difficult to see.
+grep -n "[^	 -~]" \
+	$(${FIND_FILES} | sed 's|^\./||' | sort | \
+		grep "$INCLUDED_FILES" | \
+		grep -v "$EXCLUDED_DIRS" | \
+		grep -v "$EXCLUDED_FILES") | \
+	grep -v "$EXCLUDED_PHRASES" | \
+	grep -v "$EXCLUDED_NAMES" | \
+	grep --color='auto' "[^	 -~]"