Teach "guilt graph" the "-x exclude-pattern" option.

Some projects keep a ChangeLog which every commit modifies. This makes the graph a very uninteresting single line of commits. It is sometimes useful to see how the graph would look if we ignore the ChangeLog file. The new -x option is useful in situations like this. It can be repeated several times to ignore many files. Each argument is saved to a temporary file and "grep -v -f $TEMPORARY" is used to filter out the file names you want to ignore. Also added a minimal test case and documentation. Signed-off-by: Per Cederqvist <[email protected]> Signed-off-by: Josef 'Jeff' Sipek <[email protected]>
jeffpc · Jan 23, 2015 · 669732c · 669732c
1 parent 33b3f01
commit 669732c
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 6 deletions.
diff --git a/Documentation/guilt-graph.txt b/Documentation/guilt-graph.txt
@@ -16,6 +16,11 @@ patches.
 
 OPTIONS
 -------
+-x <pattern>::
+	Ignore files that matches the given grep pattern. Can be
+	repeated to ignore several files. This can be useful to ignore
+	for instance ChangeLog files that every commit modifies.
+
 <patchname>::
 	Instead of starting with the topmost applied patch, start with
 	<patchname>.

diff --git a/guilt-graph b/guilt-graph
@@ -3,14 +3,30 @@
 # Copyright (c) Josef "Jeff" Sipek, 2007-2013
 #
 
-USAGE="[<patchname>]"
+USAGE="[-x exclude-pattern]... [<patchname>]"
 if [ -z "$GUILT_VERSION" ]; then
 	echo "Invoking `basename "$0"` directly is no longer supported." >&2
 	exit 1
 fi
 
 _main() {
 
+cache="$GUILT_DIR/$branch/.graphcache.$$"
+xclude="$GUILT_DIR/$branch/.graphexclude.$$"
+trap "rm -rf \"$cache\" \"$xclude\"" 0
+mkdir "$cache"
+>"$xclude"
+
+while [ $# -gt 0 ]; do
+	if [ "$1" = "-x" ] && [ $# -ge 2 ]; then
+		echo "$2" >> "$xclude"
+		shift
+		shift
+	else
+		break
+	fi
+done
+
 if [ $# -gt 1 ]; then
 	usage
 fi
@@ -39,10 +55,6 @@ getfiles()
 	git diff-tree -r "$1^" "$1" | cut -f2
 }
 
-cache="$GUILT_DIR/$branch/.graphcache.$$"
-mkdir "$cache"
-trap "rm -rf \"$cache\"" 0
-
 disp "digraph G {"
 
 current="$top"
@@ -66,7 +78,7 @@ while [ "$current" != "$base" ]; do
 	rm -f "$cache/dep"
 	touch "$cache/dep"
 
-	getfiles $current | while read f; do
+	getfiles $current | grep -v -f "$xclude" | while read f; do
 		# hash the filename
 		fh=`echo "$f" | sha1 | cut -d' ' -f1`
 		if [ -e "$cache/$fh" ]; then

diff --git a/regression/t-033.out b/regression/t-033.out
@@ -88,3 +88,15 @@ digraph G {
 	"ff2775f8d1dc753f635830adcc3a067e0b681e2d" [label="a.patch"]
 	"891bc14b5603474c9743fd04f3da888644413dc5" -> "ff2775f8d1dc753f635830adcc3a067e0b681e2d"; // ?
 }
+%% The same graph, but excluding deps introduced by file.txt.
+% guilt graph -x file.txt
+digraph G {
+# checking rev bc7df666a646739eaf559af23cab72f2bfd01f0e
+	"bc7df666a646739eaf559af23cab72f2bfd01f0e" [label="a-\"better&quicker'-patch.patch"]
+# checking rev 891bc14b5603474c9743fd04f3da888644413dc5
+	"891bc14b5603474c9743fd04f3da888644413dc5" [label="c.patch"]
+# checking rev c7014443c33d2b0237293687ceb9cbd38313df65
+	"c7014443c33d2b0237293687ceb9cbd38313df65" [label="b.patch"]
+# checking rev ff2775f8d1dc753f635830adcc3a067e0b681e2d
+	"ff2775f8d1dc753f635830adcc3a067e0b681e2d" [label="a.patch"]
+}
diff --git a/regression/t-033.sh b/regression/t-033.sh
@@ -59,3 +59,6 @@ cmd git add file.txt
 cmd guilt refresh
 fixup_time_info "a-\"better&quicker'-patch.patch"
 cmd guilt graph
+
+echo "%% The same graph, but excluding deps introduced by file.txt."
+cmd guilt graph -x file.txt