Skip to content

Commit b9f171c

Browse files
committed
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
2 parents c0808fe + 1884df1 commit b9f171c

File tree

1 file changed

+34
-33
lines changed

1 file changed

+34
-33
lines changed

Documentation/git-bundle.txt

Lines changed: 34 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-bundle - Move objects and refs by archive
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git bundle' create <file> <git-rev-list args>
12+
'git bundle' create <file> <git-rev-list-args>
1313
'git bundle' verify <file>
1414
'git bundle' list-heads <file> [refname...]
1515
'git bundle' unbundle <file> [refname...]
@@ -34,45 +34,46 @@ OPTIONS
3434
-------
3535

3636
create <file>::
37-
Used to create a bundle named 'file'. This requires the
38-
'git rev-list' arguments to define the bundle contents.
37+
Used to create a bundle named 'file'. This requires the
38+
'git-rev-list-args' arguments to define the bundle contents.
3939

4040
verify <file>::
41-
Used to check that a bundle file is valid and will apply
42-
cleanly to the current repository. This includes checks on the
43-
bundle format itself as well as checking that the prerequisite
44-
commits exist and are fully linked in the current repository.
45-
'git bundle' prints a list of missing commits, if any, and exits
46-
with a non-zero status.
41+
Used to check that a bundle file is valid and will apply
42+
cleanly to the current repository. This includes checks on the
43+
bundle format itself as well as checking that the prerequisite
44+
commits exist and are fully linked in the current repository.
45+
'git bundle' prints a list of missing commits, if any, and exits
46+
with a non-zero status.
4747

4848
list-heads <file>::
49-
Lists the references defined in the bundle. If followed by a
50-
list of references, only references matching those given are
51-
printed out.
49+
Lists the references defined in the bundle. If followed by a
50+
list of references, only references matching those given are
51+
printed out.
5252

5353
unbundle <file>::
54-
Passes the objects in the bundle to 'git index-pack'
55-
for storage in the repository, then prints the names of all
56-
defined references. If a list of references is given, only
57-
references matching those in the list are printed. This command is
58-
really plumbing, intended to be called only by 'git fetch'.
59-
60-
[git-rev-list-args...]::
61-
A list of arguments, acceptable to 'git rev-parse' and
62-
'git rev-list', that specifies the specific objects and references
63-
to transport. For example, `master~10..master` causes the
64-
current master reference to be packaged along with all objects
65-
added since its 10th ancestor commit. There is no explicit
66-
limit to the number of references and objects that may be
67-
packaged.
54+
Passes the objects in the bundle to 'git index-pack'
55+
for storage in the repository, then prints the names of all
56+
defined references. If a list of references is given, only
57+
references matching those in the list are printed. This command is
58+
really plumbing, intended to be called only by 'git fetch'.
59+
60+
<git-rev-list-args>::
61+
A list of arguments, acceptable to 'git rev-parse' and
62+
'git rev-list' (and containg a named ref, see SPECIFYING REFERENCES
63+
below), that specifies the specific objects and references
64+
to transport. For example, `master{tilde}10..master` causes the
65+
current master reference to be packaged along with all objects
66+
added since its 10th ancestor commit. There is no explicit
67+
limit to the number of references and objects that may be
68+
packaged.
6869

6970

7071
[refname...]::
71-
A list of references used to limit the references reported as
72-
available. This is principally of use to 'git fetch', which
73-
expects to receive only those references asked for and not
74-
necessarily everything in the pack (in this case, 'git bundle' acts
75-
like 'git fetch-pack').
72+
A list of references used to limit the references reported as
73+
available. This is principally of use to 'git fetch', which
74+
expects to receive only those references asked for and not
75+
necessarily everything in the pack (in this case, 'git bundle' acts
76+
like 'git fetch-pack').
7677

7778
SPECIFYING REFERENCES
7879
---------------------
@@ -154,7 +155,7 @@ machineB$ git pull
154155
If you know up to what commit the intended recipient repository should
155156
have the necessary objects, you can use that knowledge to specify the
156157
basis, giving a cut-off point to limit the revisions and objects that go
157-
in the resulting bundle. The previous example used lastR2bundle tag
158+
in the resulting bundle. The previous example used the lastR2bundle tag
158159
for this purpose, but you can use any other options that you would give to
159160
the linkgit:git-log[1] command. Here are more examples:
160161

@@ -194,7 +195,7 @@ references when fetching:
194195
$ git fetch mybundle master:localRef
195196
----------------
196197

197-
You can also see what references it offers.
198+
You can also see what references it offers:
198199

199200
----------------
200201
$ git ls-remote mybundle

0 commit comments

Comments
 (0)