diff options
author | Martin Roth <martinroth@google.com> | 2017-08-03 09:55:07 -0600 |
---|---|---|
committer | Martin Roth <martinroth@google.com> | 2017-08-17 11:27:02 +0000 |
commit | 992d8a7711808e7c9ce61c4714d4040ca1cd7e28 (patch) | |
tree | 654e4026d79f9b1b568c2ad73a49c4d8c1928128 /util/lint/lint-extended-015-final-newlines | |
parent | 0bb936da9ae2454307a1ffb4c97aa7c822c09a9c (diff) |
util/lint: Change final-newlines to lint-test from lint-extended-test
The final newline check is taking longer than we'd like to run. Since
it runs on every commit as part of the pre-commit check, we want that
to run faster than it currently does.
Remove LINT_SKIP_NEWLINE_CHECK as it's no longer needed.
Change-Id: Ie945dd6caba84e0d23af499d43367d70b1696089
Signed-off-by: Martin Roth <martinroth@google.com>
Reviewed-on: https://review.coreboot.org/20872
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Diffstat (limited to 'util/lint/lint-extended-015-final-newlines')
-rwxr-xr-x | util/lint/lint-extended-015-final-newlines | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/util/lint/lint-extended-015-final-newlines b/util/lint/lint-extended-015-final-newlines new file mode 100755 index 0000000000..bfaa817e1f --- /dev/null +++ b/util/lint/lint-extended-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$\|\.png$\|\.patch$' + +# 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 |