Patch set updated for serialice: 830d88f SerialICE/Makefile: Create gitconfig target.

[Edward O'Callaghan]

Edward O'Callaghan ([e-mail]) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/5215

-gerrit

commit 830d88f1dd82ddbb7ecd330270347be049c474b3
Author: Edward O'Callaghan <[e-mail]>
Date:   Fri Feb 14 01:53:18 2014 +1100

    SerialICE/Makefile: Create gitconfig target.
    
    Provide for gitconfig Makefile target and some example pre-commit lint
    check hooks.
    
    Change-Id: I49ce2791f740089f5867fe2221cbbbd1e1c6a8a7
    Signed-off-by: Edward O'Callaghan <[e-mail]>
---
 Makefile                             |  34 +++++++
 util/gitconfig/commit-msg            | 173 +++++++++++++++++++++++++++++++++++
 util/gitconfig/pre-commit            |   2 +
 util/lint/lint-000-license-headers   |  35 +++++++
 util/lint/lint-stable-003-whitespace |  43 +++++++++
 5 files changed, 287 insertions(+)

diff --git a/Makefile b/Makefile
index 46d4657..95d2bb1 100644
--- a/Makefile
+++ b/Makefile
@@ -60,3 +60,37 @@ buildall:
 		mv build build-$$board; \
 	done
 
+#######################################################################
+# Development utilities
+lint lint-stable:
+	FAILED=0; LINTLOG=`mktemp .tmpconfig.lintXXXXX`; \
+	for script in util/lint/$@-*; do \
+		echo; echo `basename $$script`; \
+		grep "^# DESCR:" $$script | sed "s,.*DESCR: *,," ; \
+		echo ========; \
+		$$script > $$LINTLOG; \
+		if [ `cat $$LINTLOG | wc -l` -eq 0 ]; then \
+			printf "success\n\n"; \
+		else \
+			echo test failed: ; \
+			cat $$LINTLOG; \
+			rm -f $$LINTLOG; \
+			FAILED=$$(( $$FAILED + 1 )); \
+		fi; \
+		echo ========; \
+	done; \
+	test $$FAILED -eq 0 || { echo "ERROR: $$FAILED test(s) failed." &&  exit 1; }; \
+	rm -f $$LINTLOG
+
+gitconfig:
+	mkdir -p .git/hooks
+	for hook in commit-msg pre-commit ; do                       \
+		if [ util/gitconfig/$$hook -nt .git/hooks/$$hook -o  \
+		! -x .git/hooks/$$hook ]; then			     \
+			cp util/gitconfig/$$hook .git/hooks/$$hook;  \
+			chmod +x .git/hooks/$$hook;		     \
+		fi;						     \
+	done
+	git config remote.origin.push HEAD:refs/for/master
+	(git config --global user.name >/dev/null && git config --global user.email >/dev/null) || (printf 'Please configure your name and email in git:\n\n git config --global user.name "Your Name Comes Here"\n git config --global user.email [e-mail]\n'; exit 1)
+
diff --git a/util/gitconfig/commit-msg b/util/gitconfig/commit-msg
new file mode 100755
index 0000000..82f0581
--- /dev/null
+++ b/util/gitconfig/commit-msg
@@ -0,0 +1,173 @@
+#!/bin/sh
+#
+# Part of Gerrit Code Review (http://code.google.com/p/gerrit/)
+#
+# Copyright (C) 2009 The Android Open Source Project
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+CHANGE_ID_AFTER="Bug|Issue"
+MSG="$1"
+
+# Check for, and add if missing, a unique Change-Id
+#
+add_ChangeId() {
+	clean_message=`sed -e '
+		/^diff --git a\/.*/{
+			s///
+			q
+		}
+		/^Signed-off-by:/d
+		/^#/d
+	' "$MSG" | git stripspace`
+	if test -z "$clean_message"
+	then
+		return
+	fi
+
+	# Does Change-Id: already exist? if so, exit (no change).
+	if grep -i '^Change-Id: I[0-9a-f]\{40\}$' "$MSG" >/dev/null
+	then
+		return
+	fi
+
+	id=`_gen_ChangeId`
+	T="$MSG.tmp.$$"
+	AWK=awk
+	if [ -x /usr/xpg4/bin/awk ]; then
+		# Solaris AWK is just too broken
+		AWK=/usr/xpg4/bin/awk
+	fi
+
+	# How this works:
+	# - parse the commit message as (textLine+ blankLine*)*
+	# - assume textLine+ to be a footer until proven otherwise
+	# - exception: the first block is not footer (as it is the title)
+	# - read textLine+ into a variable
+	# - then count blankLines
+	# - once the next textLine appears, print textLine+ blankLine* as these
+	#   aren't footer
+	# - in END, the last textLine+ block is available for footer parsing
+	$AWK '
+	BEGIN {
+		# while we start with the assumption that textLine+
+		# is a footer, the first block is not.
+		isFooter = 0
+		footerComment = 0
+		blankLines = 0
+	}
+
+	# Skip lines starting with "#" without any spaces before it.
+	/^#/ { next }
+
+	# Skip the line starting with the diff command and everything after it,
+	# up to the end of the file, assuming it is only patch data.
+	# If more than one line before the diff was empty, strip all but one.
+	/^diff --git a/ {
+		blankLines = 0
+		while (getline) { }
+		next
+	}
+
+	# Count blank lines outside footer comments
+	/^$/ && (footerComment == 0) {
+		blankLines++
+		next
+	}
+
+	# Catch footer comment
+	/^\[[a-zA-Z0-9-]+:/ && (isFooter == 1) {
+		footerComment = 1
+	}
+
+	/]$/ && (footerComment == 1) {
+		footerComment = 2
+	}
+
+	# We have a non-blank line after blank lines. Handle this.
+	(blankLines > 0) {
+		print lines
+		for (i = 0; i < blankLines; i++) {
+			print ""
+		}
+
+		lines = ""
+		blankLines = 0
+		isFooter = 1
+		footerComment = 0
+	}
+
+	# Detect that the current block is not the footer
+	(footerComment == 0) && (!/^\[?[a-zA-Z0-9-]+:/ || /^[a-zA-Z0-9-]+:\/\//) {
+		isFooter = 0
+	}
+
+	{
+		# We need this information about the current last comment line
+		if (footerComment == 2) {
+			footerComment = 0
+		}
+		if (lines != "") {
+			lines = lines "\n";
+		}
+		lines = lines $0
+	}
+
+	# Footer handling:
+	# If the last block is considered a footer, splice in the Change-Id at the
+	# right place.
+	# Look for the right place to inject Change-Id by considering
+	# CHANGE_ID_AFTER. Keys listed in it (case insensitive) come first,
+	# then Change-Id, then everything else (eg. Signed-off-by:).
+	#
+	# Otherwise just print the last block, a new line and the Change-Id as a
+	# block of its own.
+	END {
+		unprinted = 1
+		if (isFooter == 0) {
+			print lines "\n"
+			lines = ""
+		}
+		changeIdAfter = "^(" tolower("'"$CHANGE_ID_AFTER"'") "):"
+		numlines = split(lines, footer, "\n")
+		for (line = 1; line <= numlines; line++) {
+			if (unprinted && match(tolower(footer[line]), changeIdAfter) != 1) {
+				unprinted = 0
+				print "Change-Id: I'"$id"'"
+			}
+			print footer[line]
+		}
+		if (unprinted) {
+			print "Change-Id: I'"$id"'"
+		}
+	}' "$MSG" > $T && mv $T "$MSG" || rm -f $T
+}
+_gen_ChangeIdInput() {
+	echo "tree `git write-tree`"
+	if parent=`git rev-parse "HEAD^0" 2>/dev/null`
+	then
+		echo "parent $parent"
+	fi
+	echo "author `git var GIT_AUTHOR_IDENT`"
+	echo "committer `git var GIT_COMMITTER_IDENT`"
+	echo
+	printf '%s' "$clean_message"
+}
+_gen_ChangeId() {
+	_gen_ChangeIdInput |
+	git hash-object -t commit --stdin
+}
+
+
+add_ChangeId
diff --git a/util/gitconfig/pre-commit b/util/gitconfig/pre-commit
new file mode 100755
index 0000000..8ab3e56
--- /dev/null
+++ b/util/gitconfig/pre-commit
@@ -0,0 +1,2 @@
+#!/bin/sh
+exec make lint-stable
diff --git a/util/lint/lint-000-license-headers b/util/lint/lint-000-license-headers
new file mode 100755
index 0000000..2009c41
--- /dev/null
+++ b/util/lint/lint-000-license-headers
@@ -0,0 +1,35 @@
+#!/bin/sh
+# This file is part of the coreboot project.
+#
+# Copyright (C) 2010 coresystems GmbH
+#
+# 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+#
+#
+# DESCR: Check that all files in src/ and util/ have valid license headers
+
+LC_ALL=C export LC_ALL
+find SerialICE util -name .svn -type d -prune -o \
+	-name README -prune -o \
+	-name LICENSE -prune -o \
+	-name TODO -prune -o \
+	-name COPYING -prune -o \
+	-name microcode-\*.h -prune -o \
+	-name \*.[18] -prune -o \
+	-name romcc -type d -prune -o \
+	-name crossgcc -type d -prune -o \
+	-name vendorcode -type d -prune -o \
+	-type f -exec \
+		grep -L "51 Franklin St, Fifth Floor, Boston" {} + | \
+	sed -e "s,^.*$,File & has no valid GPL header.,"
diff --git a/util/lint/lint-stable-003-whitespace b/util/lint/lint-stable-003-whitespace
new file mode 100755
index 0000000..d20b6ce
--- /dev/null
+++ b/util/lint/lint-stable-003-whitespace
@@ -0,0 +1,43 @@
+#!/bin/sh
+# This file is part of the coreboot project.
+#
+# Copyright (C) 2011 Patrick Georgi <[e-mail]>
+#
+# 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+#
+# DESCR: Check for superfluous whitespace in the tree
+
+LC_ALL=C export LC_ALL
+find SerialICE util -name .svn -type d -prune -o \
+	-type f -perm /111 -prune -o \
+	-name .git -type d -prune -o \
+	-name README -prune -o \
+	-name LICENSE -prune -o \
+	-name TODO -prune -o \
+	-name COPYING -prune -o \
+	-name \*.txt -prune -o \
+	-name \*.exe -prune -o \
+	-name \*.o -prune -o \
+	-name microcode-\*.h -prune -o \
+	-name \*.?_shipped -prune -o \
+	-name \*.[18] -prune -o \
+	-name \*~ -prune -o \
+	-name kconfig -type d -prune -o \
+	-name romcc -type d -prune -o \
+	-name crossgcc -type d -prune -o \
+	-name vendorcode -type d -prune -o \
+	-type f -exec \
+		grep -l "[[:space:]][[:space:]]*$" {} + | \
+	sed -e "s,^.*$,File & has lines ending with whitespace.,"
+