aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2010-09-03 09:43:42 -0700
committerJunio C Hamano <gitster@pobox.com>2010-09-03 09:43:42 -0700
commitb9f171cc3b3f7f528acf672b5fef7e95b153213b (patch)
tree4c361f06bbe19ca6ed9bf91f77fd246ac2faa3d4
parentc0808fe70870f513a4fc020ec23500b88f8b1018 (diff)
parent1884df1aad3d1745bb3abcd6a717ab3d41623779 (diff)
downloadgit-b9f171cc3b3f7f528acf672b5fef7e95b153213b.tar.gz
git-b9f171cc3b3f7f528acf672b5fef7e95b153213b.tar.xz
Merge branch 'mg/doc-bundle'
* mg/doc-bundle: git-bundle.txt: Clarify rev-list-args restrictions git-bundle.txt: whitespace cleanup git-bundle.txt: Cleanup Conflicts: Documentation/git-bundle.txt
-rw-r--r--Documentation/git-bundle.txt67
1 files changed, 34 insertions, 33 deletions
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index f0b75c7e6..38e59afb3 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -9,7 +9,7 @@ git-bundle - Move objects and refs by archive
SYNOPSIS
--------
[verse]
-'git bundle' create <file> <git-rev-list args>
+'git bundle' create <file> <git-rev-list-args>
'git bundle' verify <file>
'git bundle' list-heads <file> [refname...]
'git bundle' unbundle <file> [refname...]
@@ -34,45 +34,46 @@ OPTIONS
-------
create <file>::
- Used to create a bundle named 'file'. This requires the
- 'git rev-list' arguments to define the bundle contents.
+ Used to create a bundle named 'file'. This requires the
+ 'git-rev-list-args' arguments to define the bundle contents.
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 a non-zero status.
+ 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 a non-zero status.
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.
+ Lists the references defined in the bundle. If followed by a
+ list of references, only references matching those given are
+ printed out.
unbundle <file>::
- Passes the objects in the bundle to 'git index-pack'
- for storage in the repository, then prints the names of all
- defined references. If a list of references is given, only
- references matching those in the list are printed. This command is
- really plumbing, intended to be called only by 'git fetch'.
-
-[git-rev-list-args...]::
- A list of arguments, acceptable to 'git rev-parse' and
- 'git rev-list', that specifies 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.
+ Passes the objects in the bundle to 'git index-pack'
+ for storage in the repository, then prints the names of all
+ defined references. If a list of references is given, only
+ references matching those in the list are printed. This command is
+ really plumbing, intended to be called only by 'git fetch'.
+
+<git-rev-list-args>::
+ A list of arguments, acceptable to 'git rev-parse' and
+ 'git rev-list' (and containg a named ref, see SPECIFYING REFERENCES
+ below), that specifies the specific objects and references
+ to transport. For example, `master{tilde}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.
[refname...]::
- A list of references used to limit the references reported as
- available. This is principally of use to 'git fetch', which
- expects to receive only those references asked for and not
- necessarily everything in the pack (in this case, 'git bundle' acts
- like 'git fetch-pack').
+ A list of references used to limit the references reported as
+ available. This is principally of use to 'git fetch', which
+ expects to receive only those references asked for and not
+ necessarily everything in the pack (in this case, 'git bundle' acts
+ like 'git fetch-pack').
SPECIFYING REFERENCES
---------------------
@@ -154,7 +155,7 @@ machineB$ git pull
If you know up to what commit the intended recipient repository should
have the necessary objects, you can use that knowledge to specify the
basis, giving a cut-off point to limit the revisions and objects that go
-in the resulting bundle. The previous example used lastR2bundle tag
+in the resulting bundle. The previous example used the lastR2bundle tag
for this purpose, but you can use any other options that you would give to
the linkgit:git-log[1] command. Here are more examples:
@@ -194,7 +195,7 @@ references when fetching:
$ git fetch mybundle master:localRef
----------------
-You can also see what references it offers.
+You can also see what references it offers:
----------------
$ git ls-remote mybundle