From a068b0af59e78a27ba1ef23e59182d8d7429c7e8 Mon Sep 17 00:00:00 2001
From: Krisztian Litkey <krisztian.litkey@intel.com>
Date: Fri, 20 Oct 2023 19:53:27 +0300
Subject: [PATCH] .githook,Makefile: add in-repo .githooks.

Add pre-commit git hook to check for trailing whitespace.
Add Makefile target 'install-git-hooks' for enabling in-
repo (pre-commit) git hooks.

Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
---
 .githooks/pre-commit                       |  1 +
 .githooks/pre-commit.d/00-stock-git-checks | 49 ++++++++++++++++++++++
 .githooks/run-hooks                        | 31 ++++++++++++++
 Makefile                                   |  8 ++++
 4 files changed, 89 insertions(+)
 create mode 120000 .githooks/pre-commit
 create mode 100755 .githooks/pre-commit.d/00-stock-git-checks
 create mode 100755 .githooks/run-hooks

diff --git a/.githooks/pre-commit b/.githooks/pre-commit
new file mode 120000
index 000000000..1d6ce1868
--- /dev/null
+++ b/.githooks/pre-commit
@@ -0,0 +1 @@
+run-hooks
\ No newline at end of file
diff --git a/.githooks/pre-commit.d/00-stock-git-checks b/.githooks/pre-commit.d/00-stock-git-checks
new file mode 100755
index 000000000..be32e5f2e
--- /dev/null
+++ b/.githooks/pre-commit.d/00-stock-git-checks
@@ -0,0 +1,49 @@
+#!/usr/bin/sh
+#
+# An example hook script to verify what is about to be committed.
+# Called by "git commit" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message if
+# it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-commit".
+
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=$(git hash-object -t tree /dev/null)
+fi
+
+# If you want to allow non-ASCII filenames set this variable to true.
+allownonascii=$(git config --type=bool hooks.allownonascii)
+
+# Redirect output to stderr.
+exec 1>&2
+
+# Cross platform projects tend to avoid non-ASCII filenames; prevent
+# them from being added to the repository. We exploit the fact that the
+# printable range starts at the space character and ends with tilde.
+if [ "$allownonascii" != "true" ] &&
+	# Note that the use of brackets around a tr range is ok here, (it's
+	# even required, for portability to Solaris 10's /usr/bin/tr), since
+	# the square bracket bytes happen to fall in the designated range.
+	test $(git diff --cached --name-only --diff-filter=A -z $against |
+	  LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
+then
+	cat <<\EOF
+Error: Attempt to add a non-ASCII file name.
+
+This can cause problems if you want to work with people on other platforms.
+
+To be portable it is advisable to rename the file.
+
+If you know what you are doing you can disable this check using:
+
+  git config hooks.allownonascii true
+EOF
+	exit 1
+fi
+
+# If there are whitespace errors, print the offending file names and fail.
+exec git diff-index --check --cached $against --
diff --git a/.githooks/run-hooks b/.githooks/run-hooks
new file mode 100755
index 000000000..88634dd01
--- /dev/null
+++ b/.githooks/run-hooks
@@ -0,0 +1,31 @@
+#!/bin/bash
+
+hook="${0##*/}"
+dotd="${0}.d"
+orig="${0%/*}/../.git/hooks/$hook"
+
+exec 1>&2
+
+for h in "$dotd"/???*; do
+    case "$h" in
+        *~|*.swp)
+            continue
+            ;;
+        [0-9]*-*)
+            ;;
+    esac
+    if [ ! -x "$h" ]; then
+        continue
+    fi
+
+    echo "[running git hook ${h##*/}]"
+    $h $@
+    status=$?
+    if [ $status != 0 ]; then
+        exit $status
+    fi
+done
+
+if [ -x "$orig" ]; then
+    exec $orig
+fi
diff --git a/Makefile b/Makefile
index fab572e0c..a23c992a5 100644
--- a/Makefile
+++ b/Makefile
@@ -433,3 +433,11 @@ site-serve: .$(DOCKER_SITE_BUILDER_IMAGE).image.stamp
 	touch $@
 
 docs: site-build
+
+#
+# rules for enabling project-specific git hooks
+#
+
+install-git-hooks:
+	$(Q)echo "Enabling in-tree git hook..."
+	git config core.hookspath .githooks