From: Mark Levedahl <mdl123@verizon.net>
To: git@vger.kernel.org
Cc: Mark Levedahl <mdl123@verizon.net>
Subject: [PATCH] Create documentation for git-bundle.
Date: Thu, 15 Feb 2007 19:19:55 -0500 [thread overview]
Message-ID: <11715851973628-git-send-email-mdl123@verizon.net> (raw)
In-Reply-To: <11715851973121-git-send-email-mdl123@verizon.net>
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
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
next prev parent reply other threads:[~2007-02-16 0:20 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-02-16 0:19 Respun - Scripts to use bundles to move data between repos Mark Levedahl
2007-02-16 0:19 ` [PATCH] Add git-bundle - pack objects and references for disconnected transfer Mark Levedahl
2007-02-16 0:19 ` [PATCH] Add git-unbundle - unpack " Mark Levedahl
2007-02-16 0:19 ` [PATCH] Include git-bundle and git-unbundle in Makefile Mark Levedahl
2007-02-16 0:19 ` Mark Levedahl [this message]
2007-02-16 0:19 ` [PATCH] Create documentation for git-unbundle Mark Levedahl
2007-02-16 0:19 ` [PATCH] Link git-bundle and git-unbundle docs from git(7) Mark Levedahl
2007-02-16 2:24 ` [PATCH] Add git-unbundle - unpack objects and references for disconnected transfer Junio C Hamano
2007-02-16 2:40 ` Linus Torvalds
2007-02-16 6:38 ` Mark Levedahl
2007-02-16 6:48 ` Shawn O. Pearce
2007-02-16 7:31 ` Junio C Hamano
2007-02-16 7:45 ` Shawn O. Pearce
2007-02-16 6:22 ` Mark Levedahl
2007-02-16 7:24 ` Junio C Hamano
2007-02-16 2:11 ` [PATCH] Add git-bundle - pack " Junio C Hamano
2007-02-16 4:41 ` Shawn O. Pearce
2007-02-16 7:28 ` Junio C Hamano
2007-02-16 6:39 ` Mark Levedahl
2007-02-16 6:54 ` Shawn O. Pearce
2007-02-16 11:57 ` Simon 'corecode' Schubert
2007-02-16 4:37 ` Respun - Scripts to use bundles to move data between repos Shawn O. Pearce
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=11715851973628-git-send-email-mdl123@verizon.net \
--to=mdl123@verizon.net \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).