summaryrefslogtreecommitdiff
path: root/util/lint/lint-015-final-newlines
diff options
context:
space:
mode:
authorMartin Roth <martinroth@google.com>2016-07-28 16:20:59 -0600
committerMartin Roth <martinroth@google.com>2016-08-19 18:08:25 +0200
commit2e03fbced7551211b801f7d01d5c0b0e7dcad323 (patch)
tree89a11ac1b7d1a175567983690ae1b60865a249e1 /util/lint/lint-015-final-newlines
parent5861b585e70167a61ed324a94274204e7c3ad5b3 (diff)
downloadcoreboot-2e03fbced7551211b801f7d01d5c0b0e7dcad323.tar.xz
util/lint: Add a tool to verify a single newline at the end of files
This takes way too long to run - currently about 30 seconds to look at the entire coreboot tree. Change-Id: I403934014b422528715ea95ff652babe5e18c88b Signed-off-by: Martin Roth <martinroth@google.com> Reviewed-on: https://review.coreboot.org/15976 Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Tested-by: build bot (Jenkins) Reviewed-by: Patrick Georgi <pgeorgi@google.com>
Diffstat (limited to 'util/lint/lint-015-final-newlines')
-rwxr-xr-xutil/lint/lint-015-final-newlines52
1 files changed, 52 insertions, 0 deletions
diff --git a/util/lint/lint-015-final-newlines b/util/lint/lint-015-final-newlines
new file mode 100755
index 0000000000..f80912c4cf
--- /dev/null
+++ b/util/lint/lint-015-final-newlines
@@ -0,0 +1,52 @@
+#!/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 that files end with a single newline
+
+LC_ALL=C export LC_ALL
+
+EXCLUDED_DIRS='src/vendorcode/\|util/romcc/\|cbfstool/lzma/\|cbfstool/lz4/\|Documentation/\|build/\|3rdparty/\|\.git/\|coreboot-builds/\|util/nvidia/cbootimage/'
+EXCLUDED_FILES='\.jpg$\|\.cksum$\|\.bin$\|\.hex$\|\.ico$\|\.o$\|\.bz2$\|\.xz$\|^.tmpconfig\|\.pyc$\|_shipped$\|sha256$'
+
+# 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
+
+test_for_final_newline() {
+ while read filename; do
+ # Only check non-executable regular files
+ if [ -f "$filename" ] && [ ! -x "$filename" ]; then
+
+ # Verify that there is a newline at the end
+ # $() strips trailing newlines
+ if [ -n "$(tail -c 1 "$filename")" ]; then
+ echo "$filename has no final newline."
+
+ # Verify that the file ends with only a single newline
+ # and that the file isn't empty
+ elif [ -z "$(tail -c 2 "$filename")" ] && \
+ [ -n "$(head -n 5 "$filename")" ]; then
+ echo "$filename has multiple final newlines."
+ fi
+ fi
+ done
+}
+
+${FIND_FILES} | sed 's|^\./||' | sort | \
+ grep -v "$EXCLUDED_DIRS" | \
+ grep -v "$EXCLUDED_FILES" | \
+ test_for_final_newline