[PATCH 0/8] My set of stgit helper scripts (update)

[PATCH 0/8] My set of stgit helper scripts (update)

[Yann Dirson]

These are updated versions of the scripts already posted.  Minor
updates for most (notably some compatibility with 0.12), except for
stg-cvs which got a number of fixes, as well as a huge enumeration of
limitations (I'll probably rewrite it as a glue to get tailor called
from standard stgit commands).

This brings 2 new scripts:

- stg-mdiff to display diffs of diffs (very preliminar and naive
implementation, needs much work)

- sit-sink to bury one or more patch down the stack (eg. to commit
them but keep other patches under stgit control).  Catalin will love
to learn that this is a perl script ;).  I'll rewrite it as a standard
stgit command soon (with a slight difference as to how the --to
argument is interpreted), but others may want to use it or just
comment before that.

Best regards,
-- 
Yann Dirson    <ydirson@altern.org> |
Debian-related: <dirson@debian.org> |   Support Debian GNU/Linux:
                                    |  Freedom, Power, Stability, Gratis
     http://ydirson.free.fr/        | Check <http://www.debian.org/>

[PATCH 1/8] Add contrib/stg-whatchanged: look at what would be changed by refreshing.

[Yann Dirson]

This script outputs a "metadiff" (diff of diffs, ie. diff between 2
versions of a single patch).  This is somewhat a proof of concept, and some
work is indeed needed in the way to present the results.  Consider
filtering the output at least through colordiff.

I have 2 uses for this script:
- when simply editing a patch, provides a 3rd way to check what I've done
  before refreshing (in addition to "stg diff" and "stg diff -r //bottom")
- most usefully, when resolving conflicts caused by a push, to ease
  checking of the merge result.

Signed-off-by: Yann Dirson <ydirson@altern.org>
---

 contrib/stg-whatchanged |   37 +++++++++++++++++++++++++++++++++++++
 1 files changed, 37 insertions(+), 0 deletions(-)

diff --git a/contrib/stg-whatchanged b/contrib/stg-whatchanged
new file mode 100755
index 0000000..f80d0a1
--- /dev/null
+++ b/contrib/stg-whatchanged
@@ -0,0 +1,37 @@
+#!/bin/bash
+set -e
+
+# stg-whatchanged - show a metadiff for the patch being modified,
+# especially when resolving a merge.
+
+# Copyright (c) 2006-2007 Yann Dirson <ydirson@altern.org>
+# Subject to the GNU GPL, version 2.
+
+# FIXME:
+# - should only exclude hunk headers differing only in line offsets
+# - diff coloring should show changes in context lines differently than
+#   changes in contents
+# - filter on ^index lines is a bit wide
+# - we should be able to ask diff to force a new hunk on "^@@ " to better
+#   handle them
+# - we should always show the hunk header for any changes within a hunk
+
+# default to unified diff
+if [ "$#" = 0 ]; then
+    set -- -u
+fi
+
+# Merges via "push" leave top=bottom so we must look at old patch
+# in this case (unlike, eg., "pick --fold")
+patchdir="$(git-rev-parse --git-dir)/patches/$(stg branch)/$(stg top)"
+if [ $(cat "$patchdir/bottom") = $(cat "$patchdir/top") ];
+then
+    current_cmd="stg show //top.old"
+else
+    current_cmd="stg show"
+fi
+
+colordiff "$@" \
+    -I '^index [0-9a-b]*..[0-9a-b]*' \
+    -I '^@@ .* @@' \
+    <($current_cmd) <(stg diff -r//bottom) | less -RFX

[PATCH 2/8] Add contrib/stg-show-old: show old version of a patch.

[Yann Dirson]

Signed-off-by: Yann Dirson <ydirson@altern.org>
---

 contrib/stg-show-old |   13 +++++++++++++
 1 files changed, 13 insertions(+), 0 deletions(-)

diff --git a/contrib/stg-show-old b/contrib/stg-show-old
new file mode 100755
index 0000000..acf4e7c
--- /dev/null
+++ b/contrib/stg-show-old
@@ -0,0 +1,13 @@
+#!/bin/sh
+set -e
+
+# stg-show-old - mini helper to look at the previous version of a
+# patch (current one by default)
+
+# Copyright (c) 2006-2007 Yann Dirson <ydirson@altern.org>
+# Subject to the GNU GPL, version 2.
+
+[ "$#" -le 1 ] || { echo >&2 "Usage: $(basename $0) [<patch>]"; exit 1; }
+patch="$1"
+
+stg show "${patch}//top.old"

[PATCH 3/8] Add contrib/stg-fold-files-from: pick selected changes from a patch above current one

[Yann Dirson]

Signed-off-by: Yann Dirson <ydirson@altern.org>
---

 contrib/stg-fold-files-from |   31 +++++++++++++++++++++++++++++++
 1 files changed, 31 insertions(+), 0 deletions(-)

diff --git a/contrib/stg-fold-files-from b/contrib/stg-fold-files-from
new file mode 100755
index 0000000..bfb4a1f
--- /dev/null
+++ b/contrib/stg-fold-files-from
@@ -0,0 +1,31 @@
+#!/bin/sh
+set -e
+
+# stg-fold-files-from - picks changes to one file from another patch.
+# Only supports picking from one file, but allows to select any range
+# of hunks from the file, using the -# flag to filterdiff.
+# Use together with "filterdiff --annotate" in your diff pager, to
+# identify hunk numbers easily.
+
+# usage: stg-fold-files-from <patch> [-#<n>[-<n>][,<n>]...] <file>
+
+# Copyright (c) 2006-2007 Yann Dirson <ydirson@altern.org>
+# Subject to the GNU GPL, version 2.
+
+PATCH="$1"
+shift
+
+filtercmd=cat
+hunks=
+foldflags=
+while [ "$#" -gt 0 ]; do
+    case "$1" in
+	-\#*) hunks="$1"; shift ;;
+	-t) foldflags="-t"; shift ;;
+	-*) { echo >&2 "unknown flag '$1'"; exit 1; } ;;
+	*) break ;;
+    esac
+done
+[ "$#" = 1 ] || { echo >&2 "supports one file only"; exit 1; }
+
+stg show "$PATCH" | filterdiff -p1 $hunks -i "$1" | stg fold $foldflags

[PATCH 4/8] Add contrib/stg-swallow: completely merge an unapplied patch into current one

[Yann Dirson]

Signed-off-by: Yann Dirson <ydirson@altern.org>
---

 contrib/stg-swallow |   19 +++++++++++++++++++
 1 files changed, 19 insertions(+), 0 deletions(-)

diff --git a/contrib/stg-swallow b/contrib/stg-swallow
new file mode 100755
index 0000000..5014f39
--- /dev/null
+++ b/contrib/stg-swallow
@@ -0,0 +1,19 @@
+#!/bin/sh
+set -e
+
+# stg-swallow - completely merge an unapplied patch into current one
+
+# Copyright (c) 2006-2007 Yann Dirson <ydirson@altern.org>
+# Subject to the GNU GPL, version 2.
+
+# FIXME:
+# - should provide support for conflict solving ?
+
+[ "$#" = 1 ] || { echo >&2 "Usage: $(basename $0) <patch>"; exit 1; }
+patch="$1"
+
+stg pick --fold "$patch"
+stg refresh
+stg push "$patch"
+#stg clean "$patch"
+stg pop; stg clean -u

[PATCH 5/8] Add contrib/stg-cvs: helper script to manage a mixed cvs/stgit working copy

[Yann Dirson]

This is an early prototype only, use with care, and be sure to read the
LIMITATIONS section in the script comments.

Signed-off-by: Yann Dirson <ydirson@altern.org>
---

 contrib/stg-cvs |  171 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 171 insertions(+), 0 deletions(-)

diff --git a/contrib/stg-cvs b/contrib/stg-cvs
new file mode 100755
index 0000000..7b968d6
--- /dev/null
+++ b/contrib/stg-cvs
@@ -0,0 +1,171 @@
+#!/bin/bash
+set -e
+
+# stg-cvs - helper script to manage a mixed cvs/stgit working copy.
+
+# Allows quick synchronization of a cvs mirror branch (does not try to
+# reconstruct patchsets, creates "jumbo" commits), and commits stgit
+# patches to CVS.
+
+# Copyright (c) 2007 Yann Dirson <ydirson@altern.org>
+# Subject to the GNU GPL, version 2.
+
+# NOTES
+# - you want to add a "CVS" line to .git/info/exclude
+# - you may want to add a ".git" line to the top .cvsignore
+
+# LIMITATIONS
+# - this is only a proof-of-concept prototype
+# - lacks an "init" command
+# - "commit" does not ensure the base is uptodate before trying to
+#   commit (but hey, it's CVS ;)
+# - "commit" can only commit a single patch
+# - not much robustness here
+# - still bad support for files removed in cvs (should catch "no
+#   longer in the repository" message)
+# - while fetching, if a file change was not git-update-index'd when
+#   cvs-update'd (eg. because of a stg-cvs bug), it is not seen on further
+#   fetches until it changes again, since we scan "cvs update" output.
+#   This yields possible inconsistencies with CVS.
+# - similarly, any conflict while cvs-updating (whether due to illegal
+#   changes to the cvs-mirror-branch, or due to files added to cvs but
+#   already-existing in working copy, or to directory moves inside the
+#   cvs repository, or <fill here>) has to be dealt with by hand (although
+#   the situation is better here: cvs sees the conflict on subsequent tries)
+# - this only deals with CVS but could surely be extended to any other
+#   VCS
+# - bad/no support for cvsutils:
+#   - stg push/pop operations confuse cvsu because of timestamp changes
+#   - cvspurge/cvsco would nuke .git => does not make it easy to ensure
+#     synchronisation
+# - should use a separate workspace for cvs branch like tailor does
+# - lacks synchronisation of .cvsignore <-> .gitignore
+# - no support for filenames with spaces (stg lacks --zero output format)
+# - git-commit is too chatty when it finds nothing to commit
+# - lacks a "quick cvs commit" feature
+# - confused by cvs keyword substitution
+
+usage()
+{
+    [ "$#" = 0 ] || echo "ERROR: $*"
+    echo "Usage: $(basename $0) <command>"
+    echo " commands: $(do_commands)"
+    exit 1
+}
+
+do_commands()
+{
+    echo $(grep '^[a-z-]*)' $0 | cut -d')' -f1)
+}
+
+do_fetch()
+{
+    local return=0
+    local path
+
+    local parent="$1"
+    local branch="$2"
+
+    # record changes from cvs into index
+    stg branch "$parent" || exit $?
+    cvs -fq update -dP | grep -v '^\? ' | tee /dev/tty | while read status path; do
+	if [ -e "$path" ]; then
+	    git update-index --add "$path" || exit $?
+	else
+	    git update-index --remove "$path" || exit $?
+	fi
+	# cvs update: `FELIN1_PEP/src/java/com/sagem/felin/ui/widget/PEPRifStateIcon.java' is no longer in the repository
+    done
+
+    # create commit
+    if git commit -m "stg-cvs sync"; then
+	:
+    else
+	return=$?
+    fi
+
+    # back to branch
+    stg branch "$branch" || exit $?
+
+    return $return
+}
+
+cvs_add_dir()
+{
+    local parent=$(dirname "$1")
+    if [ ! -e "$parent/CVS" ]; then
+	cvs_add_dir "$parent"
+    fi
+
+    cvs add "$1"
+}
+
+# get context
+branch=$(stg branch)
+parent=$(git-repo-config "branch.${branch}.merge") || 
+    usage "no declared parent for '$branch' - set branch.${branch}.merge"
+
+# extract command
+
+[ "$#" -ge 1 ] || usage
+command="$1"
+shift
+
+case "$command" in
+fetch)
+    do_fetch "$parent" "$branch"
+    ;;
+
+pull)
+    if do_fetch "$parent" "$branch"; then
+	# update
+	#  --merged
+	stg rebase "$parent"
+	stg clean --applied
+    fi
+    ;;
+
+commit)
+    # sanity asserts
+    [ $(stg applied | wc -l) = 1 ] ||
+	usage "you don't have exactly one patch applied"
+
+    # context
+    patch=$(stg top)
+    
+    # adds
+    stg files | grep ^A | cut -c3- | while read file; do
+	parent=$(dirname "$file")
+	if [ ! -e "$parent/CVS" ]; then
+	    cvs_add_dir "$parent"
+	fi
+	cvs -f add "$file"
+    done
+
+    # removes
+    stg files | grep ^D | cut -c3- | xargs -r cvs -f remove
+
+    # commit
+    stg files --bare | xargs -r cvs -fq commit \
+	-F ".git/patches/$branch/patches/$patch/description"
+
+    # sync the parent branch
+    stg branch "$parent"
+    git-cherry-pick "patches/${branch}/${patch}"
+    stg branch "${branch}"
+
+    # update
+    # --merged
+    stg rebase "$parent"
+    stg clean --applied
+    ;;
+
+_commands)
+    # hint for bash-completion people :)
+    do_commands
+    ;;
+
+*)
+    usage "unknown command '$command'"
+    ;;
+esac

[PATCH 6/8] Add contrib/stg-gitk: helper script to run gitk

[Yann Dirson]

Signed-off-by: Yann Dirson <ydirson@altern.org>
---

 contrib/stg-gitk |   61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 61 insertions(+), 0 deletions(-)

diff --git a/contrib/stg-gitk b/contrib/stg-gitk
new file mode 100755
index 0000000..dd01ef0
--- /dev/null
+++ b/contrib/stg-gitk
@@ -0,0 +1,61 @@
+#!/bin/sh
+set -e
+
+# stg-gitk - helper script to graphically display an StGIT stack
+
+# Displays given branches and stacks, without getting disturbed by
+# patch logs.
+
+# LIMITATIONS:
+# - asking gitk to "update" won't detect any new ref
+# - no support for spaces in branch names
+
+# Copyright (c) 2007 Yann Dirson <ydirson@altern.org>
+# Subject to the GNU GPL, version 2.
+
+usage()
+{
+    echo "Usage: $(basename $0) [<branches>|--all]"
+    exit 1
+}
+
+allbranches=0
+case "$1" in
+--all) allbranches=1; shift ;;
+--*) usage ;;
+*) break ;;
+esac
+
+if [ $allbranches = 1 ] && [ "$#" -gt 0 ]; then
+    usage
+fi
+
+GIT_DIR=$(git-rev-parse --git-dir)
+GIT_DIR_SPKIPLEN=$(printf "$GIT_DIR/X" | wc -c)
+
+refdirs=''
+if [ $allbranches = 1 ]; then
+    refdirs="$GIT_DIR/refs"
+else
+    if [ "$#" = 0 ]; then
+	set -- "$(stg branch)"
+    fi
+
+    for b in "$@"; do
+	if [ -e "$GIT_DIR/refs/patches/$b" ]; then
+	    # StGIT branch: show all patches
+	    refdirs="$refdirs $GIT_DIR/refs/heads/$b $GIT_DIR/refs/patches/$b"
+	elif [ -e "$GIT_DIR/refs/heads/$b" ]; then
+	    # other GIT branch
+	    refdirs="$refdirs $GIT_DIR/refs/heads/$b"
+	elif [ $(git-for-each-ref "refs/$b" | wc -l) != 0 ]; then
+	    # other ref
+	    refdirs="$refdirs $(git-for-each-ref --format="$GIT_DIR/%(refname)" "refs/$b")"
+	else
+	    echo >&2 "ERROR: no such ref '$b'"
+	    usage
+	fi
+    done
+fi
+
+gitk $(find $refdirs -type f -not -name '*.log' | cut -c${GIT_DIR_SPKIPLEN}- )

[PATCH 7/8] Add contrib/stg-mdiff: display diffs of diffs.

[Yann Dirson]

Signed-off-by: Yann Dirson <ydirson@altern.org>
---

 contrib/stg-mdiff |   23 +++++++++++++++++++++++
 1 files changed, 23 insertions(+), 0 deletions(-)

diff --git a/contrib/stg-mdiff b/contrib/stg-mdiff
new file mode 100755
index 0000000..cd0c678
--- /dev/null
+++ b/contrib/stg-mdiff
@@ -0,0 +1,23 @@
+#!/bin/bash
+set -e
+
+# stg-mdiff - display meta-diffs, ie. diffs of diffs
+
+# Main use: show evolutions of a patch.
+# eg. stg-mdiff foo@stable foo
+#     stg-mdiff foo 012345567ABCD # sha1 for "foo" as integrated upstream
+
+# Copyright (c) 2007 Yann Dirson <ydirson@altern.org>
+# Subject to the GNU GPL, version 2.
+
+usage()
+{
+    echo "Usage: $(basename $0) <patch1> <patch2>"
+    exit 1
+}
+
+if [ "$#" != 2 ]; then
+    usage
+fi
+
+colordiff -u <(stg show "$1") <(stg show "$2") | less -RFX

[PATCH 8/8] Add contrib/stg-sink: sink a patch to given location (mirrors float).

[Yann Dirson]

Signed-off-by: Yann Dirson <ydirson@altern.org>
---

 contrib/stg-sink |   44 ++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 44 insertions(+), 0 deletions(-)

diff --git a/contrib/stg-sink b/contrib/stg-sink
new file mode 100755
index 0000000..e63eb93
--- /dev/null
+++ b/contrib/stg-sink
@@ -0,0 +1,44 @@
+#!/usr/bin/perl
+use strict;
+use warnings;
+
+sub _run {
+  print(' >> ', @_, "\n");# and 0;
+  system(@_);
+}
+
+my $dopush=1;
+my $pop='pop -a';
+while (@ARGV and $ARGV[0] =~ m/^-/) {
+  if ($ARGV[0] eq '-n') {
+    $dopush=0;
+    shift @ARGV;
+  }
+  if ($ARGV[0] eq '-t') {
+    shift @ARGV;
+    $pop = 'goto '.shift @ARGV;
+  }
+}
+
+# default: sink current patch
+if (@ARGV == 0) {
+  $ARGV[0] = `stg top`;
+}
+
+my @oldapplied=`stg applied`;
+chomp (@oldapplied);
+
+_run('stg '.$pop) &&
+  die "cannot pop all patches";
+_run('stg push ' . join (' ', @ARGV)) &&
+  die "error pushing patches";
+
+if ($dopush) {
+  my @newapplied=`stg applied`;
+  chomp (@newapplied);
+  my @remaining=grep { my $check=$_;
+		       not grep { $check eq $_ } @newapplied;
+		     } @oldapplied;
+  _run('stg push ' . join (' ', @remaining)) &&
+    die "error pushing remaining patches";
+}