threads / patch / 6838

patchInclude git-bundle and git-unbundle in Makefile.

Subject: [PATCH] Include git-bundle and git-unbundle in Makefile.

## tl;dr

22 messages between Feb 16, 2007 and Feb 16, 2007. Diffs are folded; open one to read it.

replies: 21people: 5as markdown or json

Mark Levedahl· Feb 16, 2007, 00:19 UTC · lore

Respun - Scripts to use bundles to move data between repos

Respun patch for git-bundle / git-unbundle.

I am working a project using git where we have many repositories on machines that can never be directly connected, but which need to have the same objects and development history. Existing git protocols offer limited support: we can either a) publish and apply patch files branch by branch, or b) copy an entire repository from one machine to another and then do local push or fetch. While both are workable, neither is a completely satisfactory solution, so I wrote the attached scripts that support a "bundle" transfer mechanism. A bundle is a tar archive having two files: a list of references as given by git-show-ref and a pack file of objects from git-pack-objects. git-bundle creates the bundle, git-unbundle unpacks and applies at the receiving end. The means of transporting the bundle file between the machines is arbitrary (sneaker net, email, etc all can work).

This transfer protocol leaves it to the user to assure that the objects in the bundle are sufficient: git-fetch and git-push determine what is needed by comparison, but no such conversation is possible here. The approach is to specificy a range of commits to include in the bundle: e.g. git-bundle master~10..master to get the last 10 commits. Having too many is fine: git at the receiving end happily ignores duplicates. Having too few objects raises an error and references are updated only if their full set of dependencies are found in the target repository.

---

Thanks to all for comments on my previous set of patches on this topic, I have respun them, taking the following actions on the various suggestions.

1) Reformat help and .txt to fit 80 column screen: Done.
2) Use tar for the bundle, not zip. Done.
3) Link into main makefile: Done (including rename of git* to git*.sh
4) Link into Documentation/cmd-list.perl: Done.
5) Source git-sh-setup: Done (including removal of --bare and git dir
   checks).
6) Use git-index-pack rather than git-unpack-objects -Done.
7) Pipe ref list directly into git-pack-objects. - doesn't handle
   rev-list-args such as --since=5.days.ago, piping through git-rev-list
   first does so I left it that way.
8) Shallow option was broken - removed as non-essential and too hard to
   fix. (can re-add properly later if someone really wants it).
9) Dont use git-fsck, instead tell receiver what commits are needed
   directly. Done, but with regrets. git-rev-list --objects-edge needs
   to be taught to work when given --max-age, git-bundle calculates the
   required result using a shell pipeline for the moment. Will revisit
   after re-educating git-rev-list. (git-bundle does use git-rev-list
   when --max-age is not present).
10) Allow --output file, rather than --output=file. Rejected as this
   required git-bundle to check arguments for git-rev-list rather than
   letting git-rev-parse do that, or requires a specific ordering of
   inputs. The first violates separation of functions (let git-rev-parse
   handle errors on arguments it takes), or simply trades one annoyance
   for another. No available solution is better than what is there now.
11) Don't use temporary files in git-bundle. Left as is. Shell scrambles
   binary data, so cannot be used to split out a binary pack file. This
   is the service tar provides, and tar will only build from existing
   files, so temporary files are needed unless this whole thing is
   re-written in C.
Mark Levedahl
Mark Levedahl· Feb 16, 2007, 00:19 UTC · re: Mark Levedahl · lore

[PATCH] Add git-bundle - pack objects and references for disconnected transfer

Some workflows require coordinated development between repositories on machines that can never be connected. This utility creates a bundle containing a pack of objects and associated references (heads or tags) that can be independently transferred to another machine, effectively supporting git-push like operations between disconnected systems.

Signed-off-by: Mark Levedahl <mdl123@verizon.net>
---
 git-bundle.sh |  103 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 103 insertions(+), 0 deletions(-)
 create mode 100755 git-bundle.sh
Show changes to git-bundle.sh +103 −0
diff --git a/git-bundle.sh b/git-bundle.sh
new file mode 100755
index 0000000..c431b52
--- /dev/null
+++ b/git-bundle.sh
@@ -0,0 +1,103 @@
+#!/bin/sh
+# Create a bundle to carry from one git repo to another
+# (e.g., "sneaker-net" based push)
+# git-bundle <git-rev-list args>
+# git-bundle --bare <git-rev-list args>
+# creates bundle.tar in current directory (can rename of course)
+#
+# The bundle includes all refs given (--all selects every ref in the repo).
+# and all of the commit objects needed subject to the list given.
+#
+# Objects to be packed are limited by specifying one or more of
+#   ^commit-ish    - indicated commits already at the target
+#                    (can have more than one ^commit-ish)
+#   --since=xxx    - Assume target repo has all relevant commits
+#                    earlier than xxx
+
+USAGE='git-bundle [--output=file] <git-rev-list arguments>'
+SUBDIRECTORY_OK=1
+. git-sh-setup
+
+# pull out rev-list args vs program args, parse the latter
+gitrevargs=$(git-rev-parse --symbolic --revs-only $*) || exit 1
+myargs=$(git-rev-parse --no-revs $*) || exit 1
+
+bfile=bundle.tar
+nextisoutput=
+for arg in $myargs ; do
+	case "$arg" in
+		-h|--h|--he|--hel|--help)
+			echo "$USAGE"
+			exit;;
+		--output=*)
+			bfile=${arg##--output=};;
+		*)
+			die "unknown option: $arg";;
+	esac
+done
+
+# find the refs to carry along and get sha1s for each.
+refs=
+fullrevargs=
+for arg in $gitrevargs ; do
+	#ignore options and basis refs, get unambiguous ref name for things
+	# we will transport (e.g., user gives master, have heads/master and
+	# remotes/origin/master, we keep the former).
+	case "$arg" in
+		-*) fullrevargs="$fullrevargs $arg";;
+		^*) fullrevargs="$fullrevargs $arg";;
+		*)	ref=$(git-show-ref "$arg" | head -n1)
+			[ -z "$ref" ] && die "unknown reference: $arg"
+			fullrevargs="$fullrevargs ${ref#* }"
+			refs="$refs $ref"
+			;;
+	esac
+done
+[ -z "$refs" ] && die "No references specified, I don't know what to bundle."
+
+# git-rev-list cannot determine edge objects if a date restriction is given...
+# we do things a slow way if max-age or min-age are given
+fast=
+[ "${fullrevargs##*--max-age}" == "$fullrevargs" ] && \
+[ "${fullrevargs##*--min-age}" == "$fullrevargs" ] && fast=1
+
+if [ -z "$fast" ] ; then
+	# get a list of all commits that will be packed along with parents of each.
+	# A fixed git-rev-list --boundary should replace all of this.
+	echo "Finding prerequisites and commits to bundle..."
+	commits=$(git-rev-list $fullrevargs)
+	
+	# get immediate parents of each commit to include
+	parents=
+	for c in $commits ; do
+		parents="$parents $(git-rev-list --parents $c | head -1 | cut -b42-)"
+	done
+	parents=$(printf "%s\n" $parents | sort | uniq)
+	
+	# factor out what will be in this bundle, the remainder are the bundle's pre-requisites.
+	# double up commits in this as we only want things that are only in parents to appear once
+	prereqs=$(printf "%s\n" $parents $commits $commits | \
+		sort | \
+		uniq -c | \
+		grep ' 1 ' \
+		| sed 's/ *1 //')
+else
+	prereqs=$(git-rev-list --objects-edge $fullrevargs | \
+		grep '^-' | sed 's/-//')
+fi
+
+# create refs and pack
+[ -e "$bfile" ] && rm -f "$bfile" 2>/dev/null
+printf "%s\n" $prereqs > .gitBundleReferences
+echo "-" >> .gitBundleReferences
+git-show-ref $refs >> .gitBundleReferences
+(git-rev-list --objects $fullrevargs | \
+	cut -b-40 | \
+	git pack-objects --all-progress --stdout >.gitBundlePack) \
+	|| (rm -f "$bfile" ; exit)
+tar cf "$bfile"  .gitBundleReferences .gitBundlePack
+tar cf "$bfile"  .gitBundleReferences .gitBundlePack
+rm .gitBundleReferences .gitBundlePack
+
+# done
+echo "Created $bfile"

-- 
1.5.0.34.g6afaa
Mark Levedahl· Feb 16, 2007, 00:19 UTC · re: Mark Levedahl · lore

[PATCH] Add git-unbundle - unpack objects and references for disconnected transfer

Some workflows require coordinated development between repositories on machines that can never be connected. This utility unpacks a bundle containing objects and associated references (heads or tags) into the current repository, effectively supporting git-push like operations between disconnected systems.

Signed-off-by: Mark Levedahl <mdl123@verizon.net>
---
 git-unbundle.sh |   67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 67 insertions(+), 0 deletions(-)
 create mode 100755 git-unbundle.sh
Show changes to git-unbundle.sh +67 −0
diff --git a/git-unbundle.sh b/git-unbundle.sh
new file mode 100755
index 0000000..ca13305
--- /dev/null
+++ b/git-unbundle.sh
@@ -0,0 +1,67 @@
+#!/bin/sh
+# unpack a git-bundle file into current repository
+#
+# See git-bundle.
+
+USAGE="usage: git-unbundle [-f|--force] [file]"
+SUBDIRECTORY_OK=1
+. git-sh-setup
+
+bfile=bundle.tar
+force=
+while case "$#" in 0) break ;; esac
+do
+	case "$1" in
+	-f|--f|--fo|--for|--forc|--force)
+		force=1;;
+	-h|--h|--he|--hel|--help)
+		usage;;
+	-*)
+		die "unknown option: $1";;
+	*)
+		bfile="$1";;
+	esac
+	shift
+done
+
+[ -e "$bfile" ] || die "cannot find $bfile"
+
+# Get prereqs and refs in one go to avoid a third tar invocation.
+# Prereqs come first, are separated by a single - from the actual refs.
+refdata=$(tar -f "$bfile" -x --to-stdout  .gitBundleReferences)
+prereqs="${refdata%%-*}"
+refs="${refdata#*-}"
+
+# check that the prerequisites exist before unbundling.
+for sha1 in $prereqs ; do
+	git-rev-parse --verify $sha1 >& /dev/null || die "Prerequisite commit $sha1 not found."
+done
+
+# get the objects, maybe repack
+tar -f "$bfile" -x --to-stdout .gitBundlePack | git-index-pack --stdin
+
+# check each reference, assure that the result would be valid before updating local ref
+printf "%s %s\n" $refs | while read sha1 ref ; do
+	ok=
+	if [ -z "$force" ] ; then
+		# update only if non-fastforward
+		local=$(git-rev-parse --verify "$ref^0" 2>/dev/null)
+		if [ ! -z "$local" ] ; then
+			mb=$(git-merge-base $local $sha1)
+			if [ "$mb" != "$local" ] ; then
+				echo "Not applying non-fast forward update: $ref"
+			else
+				ok=1
+			fi
+		else
+			ok=1
+		fi
+	else
+		#forced, accept non-fast forward update
+		ok=1
+	fi
+	if [ ! -z "$ok" ] ; then
+		echo "updating: $ref to $sha1"
+		git-update-ref -m "git-unbundle update" $ref $sha1
+	fi
+done

-- 
1.5.0.34.g6afaa
Mark Levedahl· Feb 16, 2007, 00:19 UTC · re: Mark Levedahl · lore
Signed-off-by: Mark Levedahl <mdl123@verizon.net>
---
 Makefile |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)
Show changes to Makefile +2 −1
diff --git a/Makefile b/Makefile
index ebecbbd..c2be7a7 100644
--- a/Makefile
+++ b/Makefile
@@ -177,7 +177,8 @@ SCRIPT_SH = \
 	git-applymbox.sh git-applypatch.sh git-am.sh \
 	git-merge.sh git-merge-stupid.sh git-merge-octopus.sh \
 	git-merge-resolve.sh git-merge-ours.sh \
-	git-lost-found.sh git-quiltimport.sh
+	git-lost-found.sh git-quiltimport.sh \
+	git-bundle.sh git-unbundle.sh
 
 SCRIPT_PERL = \
 	git-add--interactive.perl \

-- 
1.5.0.34.g6afaa
Mark Levedahl· Feb 16, 2007, 00:19 UTC · re: Mark Levedahl · lore

[PATCH] Create documentation for git-bundle.

Signed-off-by: Mark Levedahl <mdl123@verizon.net>
---
 Documentation/git-bundle.txt |   87 ++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 87 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/git-bundle.txt
Show changes to Documentation/git-bundle.txt +87 −0
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
new file mode 100644
index 0000000..aed413f
--- /dev/null
+++ b/Documentation/git-bundle.txt
@@ -0,0 +1,87 @@
+git-bundle(1)
+=============
+
+NAME
+----
+git-bundle - Package objects and refs for a disconnected repository
+
+
+SYNOPSIS
+--------
+'git-bundle' [--output=file] <git-rev-list args>
+
+DESCRIPTION
+-----------
+
+Some workflows require that one or more branches of development on
+one machine be replicated on another machine, but the two machines
+cannot be directly connected so the git-fetch protocol cannot be used.
+This command creates a bundle file containing objects and references
+that can be used to update another repository (using
+gitlink:git-unbundle[1]) without phsyically connecting the two.  As no
+direct connection exists, the user must specify a basis for the bundle
+that is held by the destination repository: the bundle assumes that
+all objects in the basis are already in the destination repository.
+
+OPTIONS
+-------
+
+--output=file::
+	Specifies the name of the bundle file. Default is
+        "bundle.tar" in the current directory.
+
+<git-rev-list args>::
+
+        A list of arguments, accepatble to git-rev-parse and
+        git-rev-list, that specify the specific objects and
+        references to transport. For example,  "master~10..master"
+        causes the current master reference to be packaged along with
+        all objects added since its 10th ancestor commit. There is no
+        explicit limit to the number of references and objects that
+        may be packaged.
+
+
+SPECIFYING REFERENCES
+---------------------
+
+git-bundle will only package references that are shown by
+git-show-ref: this includes heads, tags, and remote heads.  References
+such as master~1 cannot be packaged, but are perfectly suitable for
+defining the basis.  More than one reference may be packaged, and more
+than one basis can be specified.  The objects packaged are those not
+contained in the union of the given bases.  Each basis can be
+specified explicitly (e.g., ^master~10), or implicitly (e.g.,
+master~10..master, master --since=10.days.ago).
+
+It is very important that the basis used be held by the destination.
+It is ok to err on the side of conservatism, causing the bundle file
+to contain objects already in the destination as these are ignored
+when unpacking at the destination.
+
+EXAMPLE
+-------
+
+Assume two repositories exist as R1 on machine A, and R2 on machine B.
+For whatever reason, direct connection between A and B is not allowed,
+but we can move data from A to B via some mechanism (CD, email, etc).
+We want to update R2 with developments made on branch master in R1.
+We set a tag in R1 (lastR2bundle) after the previous such transport,
+and move it afterwards to help build the bundle.
+
+in R1 on A:
+git-bundle master ^lastR2bundle
+git tag -f lastR2bundle master
+
+(move bundle.tar from A to B by some mechanism)
+
+in R2 on B:
+git-unbundle bundle.tar (3)
+
+
+Author
+------
+Written by Mark Levedahl <mdl123@verizon.net>
+
+GIT
+---
+Part of the gitlink:git[7] suite

-- 
1.5.0.34.g6afaa
Mark Levedahl· Feb 16, 2007, 00:19 UTC · re: Mark Levedahl · lore

[PATCH] Create documentation for git-unbundle.

Signed-off-by: Mark Levedahl <mdl123@verizon.net>
---
 Documentation/git-unbundle.txt |   48 ++++++++++++++++++++++++++++++++++++++++
 1 files changed, 48 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/git-unbundle.txt
Show changes to Documentation/git-unbundle.txt +48 −0
diff --git a/Documentation/git-unbundle.txt b/Documentation/git-unbundle.txt
new file mode 100644
index 0000000..99713ce
--- /dev/null
+++ b/Documentation/git-unbundle.txt
@@ -0,0 +1,48 @@
+git-unbundle(1)
+===============
+
+NAME
+----
+git-unbundle - Unpackage objects and refs
+
+SYNOPSIS
+--------
+'git-unbundle' [--force] file
+
+DESCRIPTION
+-----------
+
+Some workflows require that one or more branches of development on one
+machine be replicated on another machine, but the two machines cannot
+be directly connected so the gitlink:git-fetch[1] protocol cannot be
+used.  This command unpacks a bundle file created by
+gitlink:git-bundle[1] on another repository, adding the objects and
+updating references as defined by the donor repository.
+
+OPTIONS
+-------
+
+--force::
+        Normally only fast-forward reference updates are performed.
+        Specifying this option allows non-fast forward updates.
+
+file::
+        Bundle file created by gitlink:git-bundle[1]. Default is
+        bundle.tar.
+
+ERROR CHECKING
+--------------
+
+In addition to the checks mentioned under --force above, the bundle
+includes a list of prerequisite commits needed. If any prerequisite is
+not present, git-unbundle stops. The repository is updated using
+gitlink:git-index-pack[1] and gitlink:git-update-ref[1] which assure
+that the pack is readable and that references are updated correctly.
+
+Author
+------
+Written by Mark Levedahl <mdl123@verizon.net>
+
+GIT
+---
+Part of the gitlink:git[7] suite

-- 
1.5.0.34.g6afaa
Mark Levedahl· Feb 16, 2007, 00:19 UTC · re: Mark Levedahl · lore

[PATCH] Link git-bundle and git-unbundle docs from git(7).

Signed-off-by: Mark Levedahl <mdl123@verizon.net>
---
 Documentation/cmd-list.perl |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)
 mode change 100755 => 100644 Documentation/cmd-list.perl
Show changes to Documentation/cmd-list.perl +2 −0
diff --git a/Documentation/cmd-list.perl b/Documentation/cmd-list.perl
old mode 100755
new mode 100644
index a2d6268..3a22083
--- a/Documentation/cmd-list.perl
+++ b/Documentation/cmd-list.perl
@@ -70,6 +70,7 @@ git-archive                             mainporcelain
 git-bisect                              mainporcelain
 git-blame                               ancillaryinterrogators
 git-branch                              mainporcelain
+git-bundle                              mainporcelain
 git-cat-file                            plumbinginterrogators
 git-checkout-index                      plumbingmanipulators
 git-checkout                            mainporcelain
@@ -172,6 +173,7 @@ git-svnimport                           foreignscminterface
 git-symbolic-ref                        plumbingmanipulators
 git-tag                                 mainporcelain
 git-tar-tree                            plumbinginterrogators
+git-unbundle                            mainporcelain
 git-unpack-file                         plumbinginterrogators
 git-unpack-objects                      plumbingmanipulators
 git-update-index                        plumbingmanipulators

-- 
1.5.0.34.g6afaa
Junio C Hamano· Feb 16, 2007, 02:24 UTC · re: Mark Levedahl · lore

Re: [PATCH] Add git-unbundle - unpack objects and references for disconnected transfer

Mark Levedahl <mdl123@verizon.net> writes:
> +# check that the prerequisites exist before unbundling.
> +for sha1 in $prereqs ; do
> +	git-rev-parse --verify $sha1 >& /dev/null || die "Prerequisite commit $sha1 not found."
> +done

If you are checking only boundary commits this is too weak a check and unsafe (we used to have the same bug in http fetch long time ago). You have to make sure not only the object exists, but also it is reachable by one of the refs.

One way to check that would be to ask "describe --all" if it can find a ref that can reach that commit. It would error out if the commit object exists but is not reachable from any of the refs.

Linus Torvalds· Feb 16, 2007, 02:40 UTC · re: Junio C Hamano · lore

Re: [PATCH] Add git-unbundle - unpack objects and references for disconnected transfer

On Thu, 15 Feb 2007, Junio C Hamano wrote:
Show 5 quoted lines
> 
> One way to check that would be to ask "describe --all" if it can
> find a ref that can reach that commit.  It would error out if
> the commit object exists but is not reachable from any of the
> refs.
Actually, more efficient and to the point:
	list-all-boundary-sha1s |
		git-rev-list --stdin --not --all
should return empty. Or something like that.
		Linus
Mark Levedahl· Feb 16, 2007, 06:38 UTC · re: Linus Torvalds · lore

[PATCH] Add git-unbundle - unpack objects and references for disconnected transfer

Some workflows require coordinated development between repositories on machines that can never be connected. This utility unpacks a bundle containing objects and associated references (heads or tags) into the current repository, effectively supporting git-push like operations between disconnected systems.

Signed-off-by: Mark Levedahl <mdl123@verizon.net>
---
 git-unbundle.sh |   68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 68 insertions(+), 0 deletions(-)
 create mode 100755 git-unbundle.sh
Show changes to git-unbundle.sh +68 −0
diff --git a/git-unbundle.sh b/git-unbundle.sh
new file mode 100755
index 0000000..c947f15
--- /dev/null
+++ b/git-unbundle.sh
@@ -0,0 +1,68 @@
+#!/bin/sh
+# unpack a git-bundle file into current repository
+#
+# See git-bundle.
+
+USAGE="usage: git-unbundle [-f|--force] [file]"
+SUBDIRECTORY_OK=1
+. git-sh-setup
+
+bfile=bundle.tar
+force=
+while case "$#" in 0) break ;; esac
+do
+    case "$1" in
+    -f|--f|--fo|--for|--forc|--force)
+        force=1;;
+    -h|--h|--he|--hel|--help)
+        usage;;
+    -*)
+        die "unknown option: $1";;
+    *)
+        bfile="$1";;
+    esac
+    shift
+done
+
+test -e "$bfile" || die "cannot find $bfile"
+
+# Get prereqs and refs in one go to avoid a third tar invocation.
+# Have a header line with version, prereqs, then references.
+references=$(tar -xf "$bfile" --to-stdout references)
+refdata=${references##v1*prerequisites}
+test "$references" = "$refdata" && die "This doesn't look like a v1 bundle file."
+prereqs="${refdata%%references*}"
+refs="${refdata#*references}"
+
+# make sure prerequisites are available
+test -n "$prereqs" && printf "%s\n" $prereqs | \
+    git-rev-list --stdin --not --all || exit 1
+
+# get the pack file
+tar -xf "$bfile" --to-stdout pack | git-index-pack --stdin || exit 1
+
+# check each reference, avoid non-fast forward update unless forced
+printf "%s %s\n" $refs | while read sha1 ref ; do
+    ok=
+    if test -z "$force" ; then
+        # update only if non-fastforward
+        local=$(git-rev-parse --verify "$ref^0" 2>/dev/null)
+        if test -n "$local"  ; then
+            mb=$(git-merge-base $local $sha1)
+            if test "$mb" != "$local" ; then
+                echo "Not applying non-fast forward update: $ref"
+            else
+                ok=1
+            fi
+        else
+            ok=1
+        fi
+    else
+        #forced, accept non-fast forward update
+        ok=1
+    fi
+    if test -n "$ok" ; then
+        echo "updating: $ref to $sha1"
+        git-update-ref -m "git-unbundle update" $ref $sha1
+    fi
+done

-- 
1.5.0.rc4.375.gd0938-dirty
Shawn O. Pearce· Feb 16, 2007, 06:48 UTC · re: Mark Levedahl · lore

Re: [PATCH] Add git-unbundle - unpack objects and references for disconnected transfer

Mark Levedahl <mdl123@verizon.net> wrote:
Show 19 quoted lines
> +        # update only if non-fastforward
> +        local=$(git-rev-parse --verify "$ref^0" 2>/dev/null)
> +        if test -n "$local"  ; then
> +            mb=$(git-merge-base $local $sha1)
> +            if test "$mb" != "$local" ; then
> +                echo "Not applying non-fast forward update: $ref"
> +            else
> +                ok=1
> +            fi
> +        else
> +            ok=1
> +        fi
> +    else
> +        #forced, accept non-fast forward update
> +        ok=1
> +    fi
> +    if test -n "$ok" ; then
> +        echo "updating: $ref to $sha1"
> +        git-update-ref -m "git-unbundle update" $ref $sha1

What about passing $local as the final argument to update-ref, so that the ref won't be modified if someone changed it while an unbundle was running? Sure its mostly a manual operation, but imagine running it on a bare repository while someone else is pushing into it...

-- 
Shawn.
Junio C Hamano· Feb 16, 2007, 07:31 UTC · re: Shawn O. Pearce · lore

Re: [PATCH] Add git-unbundle - unpack objects and references for disconnected transfer

"Shawn O. Pearce" <spearce@spearce.org> writes:
Show 11 quoted lines
> Mark Levedahl <mdl123@verizon.net> wrote:
>> +        # update only if non-fastforward
>> +        local=$(git-rev-parse --verify "$ref^0" 2>/dev/null)
>> ...
>> +        git-update-ref -m "git-unbundle update" $ref $sha1
>
> What about passing $local as the final argument to update-ref,
> so that the ref won't be modified if someone changed it while
> an unbundle was running?  Sure its mostly a manual operation,
> but imagine running it on a bare repository while someone else
> is pushing into it...

The script already has $local at that point, so adding it to update-ref is a no-cost change to make things safer. I think it makes sense.

But I have to wonder... While someone else is _pushing_ into it? Why are _you_ sneakernetting, then?

Shawn O. Pearce· Feb 16, 2007, 07:45 UTC · re: Junio C Hamano · lore

Re: [PATCH] Add git-unbundle - unpack objects and references for disconnected transfer

Junio C Hamano <junkio@cox.net> wrote:
Show 16 quoted lines
> "Shawn O. Pearce" <spearce@spearce.org> writes:
> > Mark Levedahl <mdl123@verizon.net> wrote:
> >> +        # update only if non-fastforward
> >> +        local=$(git-rev-parse --verify "$ref^0" 2>/dev/null)
> >> ...
> >> +        git-update-ref -m "git-unbundle update" $ref $sha1
> >
> > What about passing $local as the final argument to update-ref,
> > so that the ref won't be modified if someone changed it while
> > an unbundle was running?  Sure its mostly a manual operation,
> > but imagine running it on a bare repository while someone else
> > is pushing into it...
> 
> The script already has $local at that point, so adding it to
> update-ref is a no-cost change to make things safer.  I think it
> makes sense.
Actually that's only if --force was not given.  If --force was
given, rev-parse wasn't run, so local is not populated.  So maybe
its not trivial.
 
> But I have to wonder...  While someone else is _pushing_ into
> it?  Why are _you_ sneakernetting, then?

People do weird things. I agree, its probably unlikely to ever happen. But give a user a length of rope, they will find a way to hang themselves...

I can see someone trying to use an update hook with bundle/unbundle to move stuff from one repository to another, despite the fact that are better ways to do that. Better that we fail when an update might lose changes.

-- 
Shawn.
Mark Levedahl· Feb 16, 2007, 06:22 UTC · re: Junio C Hamano · lore

Re: [PATCH] Add git-unbundle - unpack objects and references for disconnected transfer

Junio C Hamano wrote:
Show 18 quoted lines
> Mark Levedahl <mdl123@verizon.net> writes:
>
>   
>> +# check that the prerequisites exist before unbundling.
>> +for sha1 in $prereqs ; do
>> +	git-rev-parse --verify $sha1 >& /dev/null || die "Prerequisite commit $sha1 not found."
>> +done
>>     
>
> If you are checking only boundary commits this is too weak a
> check and unsafe (we used to have the same bug in http fetch
> long time ago).  You have to make sure not only the object
> exists, but also it is reachable by one of the refs.
>
> One way to check that would be to ask "describe --all" if it can
> find a ref that can reach that commit.  It would error out if
> the commit object exists but is not reachable from any of the
> refs

I'm not sure I follow the logic here. Assuming the object is a prerequisite of the bundle and exists, it will be reachable from an updated reference once the bundle is applied, no? In any case, Linus' suggestion is very neat and fast, and I presume reliable.

Mark
Junio C Hamano· Feb 16, 2007, 07:24 UTC · re: Mark Levedahl · lore

Re: [PATCH] Add git-unbundle - unpack objects and references for disconnected transfer

Mark Levedahl <mdl123@verizon.net> writes:
> I'm not sure I follow the logic here. Assuming the object is a
> prerequisite of the bundle and exists, it will be reachable from an
> updated reference once the bundle is applied, no?

No. That's not the point. Yes, the object might be reachable, but you haven't proven that everything necessary to complete that object is already in the object store. We never trust existence of an object alone when doing an operation that updates a ref. Having unreferenced objects in the object store is a norm, but refs pointing at an object, some of whose prerequisites are missing, is a crime.

For example, suppose an earlier http-fetch found that the updated master should be at commit 'x', downloaded 'x', and you killed the process with ^C. It died without updating refs/remotes/origin/master, which is good. Then you have a bundle to unpack that has 'x' as a boundary.

You would start with a repository like this:
  ---o---o---o...-...-...-...x
             ^origin.

where 'x' is a dangling commit, '-' are ones that you do not have but you ought to have them in order for 'x' to be complete, and 'o' are complete commits. If the bundle boundary falls on the 'x' commit, you cannot say "I have all that are needed to complete this 'x'". You only have 'x' but still lack its prerequisites. That's what it means never to trust the mere existence of an object.

Linus's suggestion would make rev-list barf when 'x' cannot reach any existing ref, which is a good solution for this problem.

Also as Shawn pointed out, the script too heavily depends on GNU tar. Can we do something about it? Requiring GNU tar is probably fine if the script absolutely needs its extended features, as long as people have ways to tweak the command name in the script to point at their installed GNU tar (remember, some systems have GNU tar under different name such as "gtar").

Although if we require GNU tar we might be better off placing this under contrib/ not at the toplevel. I dunno.

Junio C Hamano· Feb 16, 2007, 02:11 UTC · re: Mark Levedahl · lore

Re: [PATCH] Add git-bundle - pack objects and references for disconnected transfer

Mark Levedahl <mdl123@verizon.net> writes:
Show 7 quoted lines
> +# find the refs to carry along and get sha1s for each.
> +refs=
> +fullrevargs=
> +for arg in $gitrevargs ; do
> +	#ignore options and basis refs, get unambiguous ref name for things
> +	# we will transport (e.g., user gives master, have heads/master and
> +	# remotes/origin/master, we keep the former).

I am not sure if that is a good behaviour. What if user gives xyzzy and there are tags/xyzzy and remotes/origin/xyzzy?

I suspect it would be much safer to error out in ambiguous cases.
> +# we do things a slow way if max-age or min-age are given
> +fast=
> +[ "${fullrevargs##*--max-age}" == "$fullrevargs" ] && \
> +[ "${fullrevargs##*--min-age}" == "$fullrevargs" ] && fast=1
Style.

Our scripts tend to spell the test command "test" and equality test operator as single '='. Also they tend to say:

        case "$fullrevargs" in
        *--max-age* | *--min-age*) ... 
        esac
Show 5 quoted lines
> +	# get immediate parents of each commit to include
> +	parents=
> +	for c in $commits ; do
> +		parents="$parents $(git-rev-list --parents $c | head -1 | cut -b42-)"
> +	done

Nicely done, but you seemed to have used "head -n 1" elsewhere, which is more portable.

Show 7 quoted lines
> +	# factor out what will be in this bundle, the remainder are the bundle's pre-requisites.
> +	# double up commits in this as we only want things that are only in parents to appear once
> +	prereqs=$(printf "%s\n" $parents $commits $commits | \
> +		sort | \
> +		uniq -c | \
> +		grep ' 1 ' \
> +		| sed 's/ *1 //')
Don't pipe output of grep to sed ;-).
> +else
> +	prereqs=$(git-rev-list --objects-edge $fullrevargs | \
> +		grep '^-' | sed 's/-//')
> +fi
Likewise.  The latter is:
	... | sed -ne 's/^-//p'
> +# create refs and pack
> +[ -e "$bfile" ] && rm -f "$bfile" 2>/dev/null
> +printf "%s\n" $prereqs > .gitBundleReferences

Our scripts assume $GIT_DIR/ is writable but not necessarily the working directory when they have to use temporary files. Also please clean temporaries even when you error out with traps.

	tmp=$GIT_DIR/bundle_tmp$$
	references="$tmp-references"
        pack="$tmp-pack"
        trap 'rm -f "$tmp-*"' 0 1 2 3 15
        echo "-" >>"$references" &&
        git-show-ref $refs >>"$references" &&
        (git-rev-list ... >"$pack") || exit
Shawn O. Pearce· Feb 16, 2007, 04:41 UTC · re: Junio C Hamano · lore

Re: [PATCH] Add git-bundle - pack objects and references for disconnected transfer

Junio C Hamano <junkio@cox.net> wrote:
Show 10 quoted lines
> Mark Levedahl <mdl123@verizon.net> writes:
> > +# we do things a slow way if max-age or min-age are given
> > +fast=
> > +[ "${fullrevargs##*--max-age}" == "$fullrevargs" ] && \
> > +[ "${fullrevargs##*--min-age}" == "$fullrevargs" ] && fast=1
> 
> Style.
> 
> Our scripts tend to spell the test command "test" and equality test
> operator as single '='.

Using "test" is a style thing, but using "=" rather than "==" is a portability issue. "==" is accepted by bash as a synonym for "=", but its not valid elsewhere.

I've made my fair share of patches with "==" in them, only to have
someone else have a problem on their system and then submit a fix to
change them to "=".  Just say no to "==" in Git shell scripts.  ;-)
Show 8 quoted lines
> > +	# get immediate parents of each commit to include
> > +	parents=
> > +	for c in $commits ; do
> > +		parents="$parents $(git-rev-list --parents $c | head -1 | cut -b42-)"
> > +	done
> 
> Nicely done, but you seemed to have used "head -n 1" elsewhere,
> which is more portable.
What about:
	parents="$parents $(git-rev-list --max-count=1 --parents $c | cut -b42-)"
?
I just used that trick recently.  Oh yea it was in git-gui's
GIT-VERSION-GEN script.  Though I did not know about using cut
like that...
 
-- 
Shawn.
Junio C Hamano· Feb 16, 2007, 07:28 UTC · re: Shawn O. Pearce · lore

Re: [PATCH] Add git-bundle - pack objects and references for disconnected transfer

"Shawn O. Pearce" <spearce@spearce.org> writes:
> Using "test" is a style thing, but using "=" rather than "==" is
> a portability issue.  "==" is accepted by bash as a synonym for
> "=", but its not valid elsewhere.

True, I should have stressed that. Thanks. Also in the same sense (but to a lessor degree), "test" vs "[" is also portability issue.

Show 7 quoted lines
> What about:
>
> 	parents="$parents $(git-rev-list --max-count=1 --parents $c | cut -b42-)"
>
> I just used that trick recently.  Oh yea it was in git-gui's
> GIT-VERSION-GEN script.  Though I did not know about using cut
> like that...

I used to stay away from 'cut' myself, although it is not too bad for portability these days. I would probably have done the above with a single sed process, though.

Mark Levedahl· Feb 16, 2007, 06:39 UTC · re: Junio C Hamano · lore

[PATCH] Add git-bundle - pack objects and references for disconnected transfer

Some workflows require coordinated development between repositories on machines that can never be connected. This utility creates a bundle containing a pack of objects and associated references (heads or tags) that can be independently transferred to another machine, effectively supporting git-push like operations between disconnected systems.

Signed-off-by: Mark Levedahl <mdl123@verizon.net>
---
 git-bundle.sh |  112 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 112 insertions(+), 0 deletions(-)
 create mode 100755 git-bundle.sh
Show changes to git-bundle.sh +112 −0
diff --git a/git-bundle.sh b/git-bundle.sh
new file mode 100755
index 0000000..f56f499
--- /dev/null
+++ b/git-bundle.sh
@@ -0,0 +1,112 @@
+#!/bin/sh
+# Create a bundle to carry from one git repo to another
+# (e.g., "sneaker-net" based push)
+# git-bundle <git-rev-list args>
+# git-bundle --bare <git-rev-list args>
+# creates bundle.tar in current directory (can rename of course)
+#
+# The bundle includes all refs given (--all selects every ref in the repo).
+# and all of the commit objects needed subject to the list given.
+#
+# Objects to be packed are limited by specifying one or more of
+#   ^commit-ish    - indicated commits already at the target
+#                    (can have more than one ^commit-ish)
+#   --since=xxx    - Assume target repo has all relevant commits
+#                    earlier than xxx
+
+USAGE='git-bundle [-o file | --output=file] <git-rev-list arguments>'
+SUBDIRECTORY_OK=1
+. git-sh-setup
+
+bfile=bundle.tar
+args=
+while test -n "$1" ; do
+    case $1 in
+        -h|--h|--he|--hel|--help)
+            echo "$USAGE"
+            exit;;
+        --output=*)
+            bfile=${1##--output=};;
+        -o|--output)
+            shift
+            bfile=$1;;
+        *)
+            args="$args $1"
+    esac
+    shift
+done
+
+unknown=$(git-rev-parse --no-revs $args)
+test -z "$unknown" || die "unknown option: $unknown"
+gitrevargs=$(git-rev-parse --symbolic --revs-only $args) || exit 1
+
+# find the refs to carry along and get sha1s for each.
+refs=
+fullrevargs=
+for arg in $gitrevargs ; do
+    #ignore options and basis refs, get unambiguous ref name for things
+    # we will transport (e.g., user gives master, have heads/master and
+    # remotes/origin/master, we keep the former).
+    case "$arg" in
+        -*) fullrevargs="$fullrevargs $arg";;
+        ^*) fullrevargs="$fullrevargs $arg";;
+        *)  ref=$(git-show-ref "$arg")
+            test "$(echo $ref | wc -w)" = "2" || die "Ambigous reference: $arg
+$ref"
+            fullrevargs="$fullrevargs ${ref#* }"
+            refs="$refs $ref"
+            ;;
+    esac
+done
+test -z "$refs" && die "No references specified, I don't know what to bundle."
+
+# git-rev-list cannot determine edge objects if a date restriction is
+# given...  we do things a slow way if max-age or min-age are given
+case "$fullrevargs" in
+    *--max-age* | *--min-age*)
+    # get a list of all commits that will be packed along with
+    # parents of each.  A fixed git-rev-list --boundary should
+    # replace all of this.
+    echo "Finding prerequisites and commits to bundle..."
+    commits=$(git-rev-list $fullrevargs)
+
+    # get immediate parents of each commit to include
+    parents=
+    for c in $commits ; do
+        parents="$parents $(git-rev-list --parents --max-count=1 $c | cut -b42-)"
+    done
+    parents=$(printf "%s\n" $parents | sort | uniq)
+
+    # factor out what will be in this bundle, the remainder are the
+    # bundle's prerequisites.  double up commits in this as we only
+    # want things that are only in parents to appear once
+    prereqs=$(printf "%s\n" $parents $commits $commits | \
+        sort | uniq -c | sed -ne 's/^ *1 //p');;
+    *)
+        prereqs=$(git-rev-list --objects-edge $fullrevargs | sed -ne 's/^-//p');;
+esac
+
+# create refs and pack
+tmp=$GIT_DIR/bundle_tmp$$
+references="$tmp-references"
+pack="$tmp-pack"
+trap 'rm -f "$references" "$pack"' 0 1 2 3 15
+
+echo "v1" > "$references" &&
+echo "prerequisites" >> "$references" &&
+printf "%s\n" $prereqs >> "$references" &&
+echo "references" >> "$references" &&
+git-show-ref $refs >> "$references" &&
+(git-rev-list --objects $fullrevargs | \
+    cut -b-40 | \
+    git pack-objects --all-progress --stdout >> "$pack" ) \
+    || exit
+
+# create the tar file, clean up
+tar cf "$bfile" --absolute-names --transform="s,$tmp-,," \
+    --verbose --show-transformed-names \
+    "$references" "$pack"
+rm -f "$pack" "$references"
+
+# done
+echo "Created $bfile"

-- 
1.5.0.rc4.375.gd0938-dirty
Shawn O. Pearce· Feb 16, 2007, 06:54 UTC · re: Mark Levedahl · lore

Re: [PATCH] Add git-bundle - pack objects and references for disconnected transfer

Mark Levedahl <mdl123@verizon.net> wrote:
> +# create the tar file, clean up
> +tar cf "$bfile" --absolute-names --transform="s,$tmp-,," \
> +    --verbose --show-transformed-names \
> +    "$references" "$pack"

I'm not sure this will work on FreeBSD. Both 5.1 and 6.1 use tar that does not know about --absolute-names, --transform, --verbose, or --show-transformed-names.

-- 
Shawn.
Simon 'corecode' Schubert· Feb 16, 2007, 11:57 UTC · re: Shawn O. Pearce · lore

Re: [PATCH] Add git-bundle - pack objects and references for disconnected transfer

Shawn O. Pearce wrote:
Show 9 quoted lines
> Mark Levedahl <mdl123@verizon.net> wrote:
>> +# create the tar file, clean up
>> +tar cf "$bfile" --absolute-names --transform="s,$tmp-,," \
>> +    --verbose --show-transformed-names \
>> +    "$references" "$pack"
> 
> I'm not sure this will work on FreeBSD.  Both 5.1 and 6.1 use tar
> that does not know about --absolute-names, --transform, --verbose,
> or --show-transformed-names.
for portability, pax is the official choice :)  and it can even do path name modifications with -s.  but why again are we using tar there?  this data could easiliy be put in one mixed text/binary file, starting out with

#!/bin/sh echo "This is a git bundle. Use git-unbundle to process me." >&1 exit ### DATA ###

or so
cheers
  simon
-- 
Serve - BSD     +++  RENT this banner advert  +++    ASCII Ribbon   /"\
Work - Mac      +++  space for low €€€ NOW!1  +++      Campaign     \ /
Party Enjoy Relax   |   http://dragonflybsd.org      Against  HTML   \
Dude 2c 2 the max   !   http://golden-apple.biz       Mail + News   / \
Shawn O. Pearce· Feb 16, 2007, 04:37 UTC · re: Mark Levedahl · lore

Re: Respun - Scripts to use bundles to move data between repos

Mark Levedahl <mdl123@verizon.net> wrote:
> 7) Pipe ref list directly into git-pack-objects. - doesn't handle
>    rev-list-args such as --since=5.days.ago, piping through git-rev-list
>    first does so I left it that way.
Yuck.  I just went back and looked at the pack-objects source.

Apparently we only accept ref names and SHA-1 values here, and `--not` on a line by itself. Nothing else is valid.

The documentation is a little misleading, as usually when we say something is processed the same way as rev-list does it we usually also mean that any valid option to rev-list is also a valid option in that context. Here its not.

-- 
Shawn.

← back to recent threads