Autogenerated man pages for v1.5.0.2-260-g2eb065
authorJunio C Hamano <junio@hera.kernel.org>
Thu, 1 Mar 2007 01:25:11 +0000 (01:25 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Thu, 1 Mar 2007 01:25:11 +0000 (01:25 +0000)
man1/git-bundle.1 [new file with mode: 0644]
man1/git-remote.1
man1/git-rev-parse.1
man7/git.7

diff --git a/man1/git-bundle.1 b/man1/git-bundle.1
new file mode 100644 (file)
index 0000000..93678bb
--- /dev/null
@@ -0,0 +1,65 @@
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "GIT\-BUNDLE" "1" "03/01/2007" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+git\-bundle \- Move objects and refs by archive
+.SH "SYNOPSIS"
+\fIgit\-bundle\fR create <file> [git\-rev\-list args] \fIgit\-bundle\fR verify <file> \fIgit\-bundle\fR list\-heads <file> [refname\&...] \fIgit\-bundle\fR unbundle <file> [refname\&...]
+.SH "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 interactive git protocols (git, ssh, rsync, http) cannot be used. This command provides suport for git\-fetch and git\-pull to operate by packaging objects and references in an archive at the originating machine, then importing those into another repository using \fBgit\-fetch\fR(1) and \fBgit\-pull\fR(1) after moving the archive by some means (i.e., by sneakernet). As no direct connection between repositories 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.
+.SH "OPTIONS"
+.TP
+create <file>
+Used to create a bundle named \fIfile\fR. This requires the git\-rev\-list arguments to define the bundle contents.
+.TP
+verify <file>
+Used to check that a bundle file is valid and will apply cleanly to the current repository. This includes checks on the bundle format itself as well as checking that the prerequisite commits exist and are fully linked in the current repository. git\-bundle prints a list of missing commits, if any, and exits with non\-zero status.
+.TP
+list\-heads <file>
+Lists the references defined in the bundle. If followed by a list of references, only references matching those given are printed out.
+.TP
+unbundle <file>
+Passes the objects in the bundle to \fBgit\-index\-pack\fR(1) for storage in the repository, then prints the names of all defined references. If a reflist is given, only references matching those in the given list are printed. This command is really plumbing, intended to be called only by \fBgit\-fetch\fR(1).
+.TP
+[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.
+.TP
+[refname\&...]
+A list of references used to limit the references reported as available. This is principally of use to git\-fetch, which expects to recieve only those references asked for and not necessarily everything in the pack (in this case, git\-bundle is acting like \fBgit\-fetch\-pack\fR(1)).
+.SH "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.
+.SH "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 create mybundle master ^lastR2bundle $ git tag \-f lastR2bundle master
+
+(move mybundle from A to B by some mechanism)
+
+in R2 on B: $ git\-bundle verify mybundle $ git\-fetch mybundle refspec
+
+where refspec is refInBundle:localRef
+
+Also, with something like this in your config:
+.sp
+.nf
+url = /home/me/tmp/file.bdl
+fetch = refs/heads/*:refs/remotes/origin/*
+.fi
+You can first sneakernet the bundle file to ~/tmp/file.bdl and then these commands:
+
+$ git ls\-remote bundle $ git fetch bundle $ git pull bundle
+
+would treat it as if it is talking with a remote side over the network.
+.SH "AUTHOR"
+Written by Mark Levedahl <mdl123@verizon.net>
+.SH "GIT"
+Part of the \fBgit\fR(7) suite
+
index 2192bd9647b6289332f2b591ee2c82d90e7930d6..5438ac9b21f29034f6ac3c86708f795ed61e5ca7 100644 (file)
@@ -2,7 +2,7 @@
 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
 .\" Instead of manually editing it, you probably should edit the DocBook XML
 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-REMOTE" "1" "02/26/2007" "" ""
+.TH "GIT\-REMOTE" "1" "03/01/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -13,7 +13,7 @@ git\-remote \- manage set of tracked repositories
 .sp
 .nf
 \fIgit\-remote\fR
-\fIgit\-remote\fR add <name> <url>
+\fIgit\-remote\fR add [\-t <branch>] [\-m <branch>] [\-f] <name> <url>
 \fIgit\-remote\fR show <name>
 \fIgit\-remote\fR prune <name>
 \fIgit\-remote\fR update [group]
@@ -43,7 +43,9 @@ Fetch updates for a named set of remotes in the repository as defined by remotes
 .SH "DISCUSSION"
 The remote configuration is achieved using the remote.origin.url and remote.origin.fetch configuration variables. (See \fBgit\-config\fR(1)).
 .SH "EXAMPLES"
-Add a new remote, fetch, and check out a branch from it:
+.TP 3
+\(bu
+Add a new remote, fetch, and check out a branch from it
 .sp
 .nf
 $ git remote
@@ -63,6 +65,17 @@ linux\-nfs/master
 $ git checkout \-b nfs linux\-nfs/master
 ...
 .fi
+.TP
+\(bu
+Imitate \fIgit clone\fR but track only selected branches
+.sp
+.nf
+$ mkdir project.git
+$ cd project.git
+$ git init
+$ git remote add \-f \-t master \-m master origin git://example.com/git.git/
+$ git merge origin
+.fi
 .SH "SEE ALSO"
 \fBgit\-fetch\fR(1) \fBgit\-branch\fR(1) \fBgit\-config\fR(1)
 .SH "AUTHOR"
index 69229c0bd49b0c82057df0535fc6dd085b9cbe79..29ee6c92bcd5fa307a012b1e30e782e80d1813be 100644 (file)
@@ -2,7 +2,7 @@
 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
 .\" Instead of manually editing it, you probably should edit the DocBook XML
 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-REV\-PARSE" "1" "02/02/2007" "" ""
+.TH "GIT\-REV\-PARSE" "1" "03/01/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -128,6 +128,9 @@ A suffix \fI^\fR followed by an object type name enclosed in brace pair (e.g. v0
 A suffix \fI^\fR followed by an empty brace pair (e.g. v0.99.8^{}) means the object could be a tag, and dereference the tag recursively until a non\-tag object is found.
 .TP
 \(bu
+A colon, followed by a slash, followed by a text: this names a commit whose commit message starts with the specified text. This name returns the youngest matching commit which is reachable from any ref. If the commit message starts with a \fI!\fR, you have to repeat that; the special sequence \fI:/!\fR, followed by something else than \fI!\fR is reserved for now.
+.TP
+\(bu
 A suffix \fI:\fR followed by a path; this names the blob or tree at the given path in the tree\-ish object named by the part before the colon.
 .TP
 \(bu
index a67ebbb81cca7e7d6261b369d2f9ffdbc64e4371..6c083316d657f2891736f4f393eabe376d3c3932 100644 (file)
@@ -2,7 +2,7 @@
 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
 .\" Instead of manually editing it, you probably should edit the DocBook XML
 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT" "7" "02/28/2007" "" ""
+.TH "GIT" "7" "03/01/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -67,6 +67,9 @@ Find the change that introduced a bug by binary search.
 \fBgit\-branch\fR(1)
 List, create, or delete branches.
 .TP
+\fBgit\-bundle\fR(1)
+Move objects and refs by archive.
+.TP
 \fBgit\-checkout\fR(1)
 Checkout and switch to a branch.
 .TP