Merge pull request #198 from zbeekman/misc-fixes

Git hooks robustness improvements and markdown tweaks

Author: zbeekman

CONTRIBUTING.md

@@ -101,7 +101,7 @@ This is the development branch, akin to GCC's `trunk`. Both of `devel` and `mast
 [these guidelines]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
 [an open issue]: https://github.com/sourceryinstitute/opencoarrays/issues
 [Create a branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
-[OpenCoarrays repo]: https://github.com/sourceryinstitute/opencoarrays#fork-destination-box
+[OpenCoarrays repo]: https://github.com/sourceryinstitute/opencoarrays/fork
 [Pull Request]: https://help.github.com/articles/using-pull-requests/
 [Fork]: https://help.github.com/articles/fork-a-repo/
 [helping out]: #helping-out

STATUS.md

@@ -192,7 +192,7 @@ To-Do List
   [Numerical Algorithms Group (nagfor)]: #compiler-issues-nag
   [Portland Group (pgfortran)]: #compiler-issues-pg
   [IBM (xlf)]: #compiler-issues-ibm
-  [forking the OpenCoarrays repository]: https://github.com/sourceryinstitute/opencoarrays/blob/master/STATUS.md#fork-destination-box
+  [forking the OpenCoarrays repository]: https://github.com/sourceryinstitute/opencoarrays/fork
 
 [TS 18508]: http://isotc.iso.org/livelink/livelink?func=ll&objId=17181227&objAction=Open
 [opencoarrays module]: ./src/extensions/opencoarrays.F90

developer-scripts/git-hooks/commit-msg

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 #
 # An example hook script to check the commit log message.
 # Called by "git commit" with one argument, the name of the file
@@ -59,7 +59,8 @@ and keeping a clean history, please see:
  2. http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
  3. https://www.reviewboard.org/docs/codebase/dev/git/clean-commits/
 
-And for funny examples of what not to do, see: http://whatthecommit.com
+And for funny examples of what not to do, see: http://whatthecommit.com and
+http://stopwritingramblingcommitmessages.com
 EOF
 
 }
@@ -77,7 +78,8 @@ test "" = "$(grep '^Signed-off-by: ' "$1" |
 # Check that the first line of the commit starts with a
 # capitalized letter.
 if ! (head -n 1 $1 | grep '^[A-Z]' &>/dev/null ); then
-    echo >&2 "First word of commit message must be a capitalized imperative verb.\n"
+    echo >&2 "First word of commit message must be a capitalized imperative verb."
+    echo ""
     let status=1
 fi
 
@@ -89,23 +91,28 @@ cat $1 | \
 	nchars=$(wc -c <<<$line)
 	if [[ "$ln" -eq "1" ]]; then
 	    if [[ "$nchars" -gt "51" ]]; then
-		echo >&2 "First line of commit message too long ($nchars > 50 chars)\n"
+		echo >&2 "First line of commit message too long ($nchars > 50 chars)"
+		echo ""
 		let status=1
 	    fi
 	elif [[ "$ln" -eq "2" ]]; then
 	    if [[ "$nchars" -gt "1" ]] && ! grep '^#' <<<"$line" >/dev/null; then
-		echo >&2 "Second line of commit message not blank\n"
+		echo >&2 "Second line of commit message not blank"
+		echo ""
 		let status=1
 	    fi
 	else
 	    if [[ "$nchars" -gt "72" ]]; then
-		echo >&2 "Line $ln of commit message too long ($nchars > 72 chars)\n"
+		echo >&2 "Line $ln of commit message too long ($nchars > 72 chars)"
+		echo ""
 		let status=1
 	    fi
 	fi
     done
 
-if [[ $status != 0 ]]; then
-    error_message
-    exit 1
+if [[ $status = 0 ]]; then
+    exit 0
 fi
+
+error_message
+exit 1

developer-scripts/git-hooks/pre-commit

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 #
 # An example hook script to verify what is about to be committed.
 # Called by "git commit" with no arguments.  The hook should
@@ -71,15 +71,18 @@ for f in $(git diff-index --name-status --cached $against | grep -v ^D | cut -c3
     if [[ "$f" =~ ([.](h|m|c|rb|sh|py|txt|md|f90|F90|cmake|x64|csh)|makefile|Makefile)$ ]] ||
        head -n 1 | grep '^#!/'; then
 	if ! ends_with_newline "$f"; then
-	    echo &>2 "No newline at end of file: $f\n"
+	    echo &>2 "No newline at end of file: $f"
+	    echo ""
 	    let status=1
 	fi
     fi
 done
 
 # If there are whitespace errors, print the offending file names and fail.
-git diff-index --check --cached $against -- || let status=1
+git diff-index --check --cached $against -- || (let status=1 echo 'white space violations found')
 
-if [[ $status != 0 ]]; then
-    exit 1
+if [[ $status = 0 ]]; then
+    exit 0
 fi
+
+exit 1

developer-scripts/setup-git.sh

@@ -8,7 +8,8 @@ if [[ "$1" ]]; then
 	echo "WARNING: Settings will be applied globally. This may over-write some of your global git settings."
 	read -p "Press Ctrl-C to abort, and try again without \`--global\` or press any key to contibue" foo
     else
-	echo -e "Usage: $0 [--global] [--help]\n"
+	echo "Usage: $0 [--global] [--help]"
+	echo ""
 	echo "This script is to configure your git environment"
 	echo "For contributing to OpenCoarrays. The \`--help\`"
 	echo "flag will print this message. The \`--global\`"