Documentation: minor grammatical fixes and rewording in git-bundle.txt
This commit also converts all reference specifications to a monospaced font, as the embedded ~ character used in some of the references sometimes causes the text up to the next ~ to be displayed incorrectly as a subscript when the HTML pages are generated. This was tested with asciidoc 8.2.5. Signed-off-by: David J. Mellor <dmellor@whistlingcat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
David J. Mellor committed
Mar 22, 2009 at 18:00 UTC
1d52b02696d01f7222419f3379565ba05faf1143
1 file changed
+43
-43
Documentation/git-bundle.txt
+43
-43
@@ -19,13 +19,13 @@ DESCRIPTION
19
20
Some workflows require that one or more branches of development on one
21
machine be replicated on another machine, but the two machines cannot
22
-be directly connected so the interactive git protocols (git, ssh,
23
-rsync, http) cannot be used. This command provides support for
22
+be directly connected, and therefore the interactive git protocols (git,
23
+ssh, rsync, http) cannot be used. This command provides support for
24
'git-fetch' and 'git-pull' to operate by packaging objects and references
25
in an archive at the originating machine, then importing those into
26
another repository using 'git-fetch' and 'git-pull'
27
after moving the archive by some means (i.e., by sneakernet). As no
28
-direct connection between repositories exists, the user must specify a
28
+direct connection between the repositories exists, the user must specify a
29
basis for the bundle that is held by the destination repository: the
30
bundle assumes that all objects in the basis are already in the
31
destination repository.
@@ -43,7 +43,7 @@ verify <file>::
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 non-zero status.
46
+ with a non-zero status.
47
48
list-heads <file>::
49
Lists the references defined in the bundle. If followed by a
@@ -53,14 +53,14 @@ list-heads <file>::
53
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 reflist is given, only references
57
- matching those in the given list are printed. This command is
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 specify the specific objects and references
63
- to transport. For example, "master~10..master" causes the
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
@@ -71,24 +71,24 @@ unbundle <file>::
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' is
75
- acting like 'git-fetch-pack').
74
+ necessarily everything in the pack (in this case, 'git-bundle' acts
75
+ like 'git-fetch-pack').
76
77
SPECIFYING REFERENCES
78
---------------------
79
80
'git-bundle' will only package references that are shown by
81
'git-show-ref': this includes heads, tags, and remote heads. References
82
-such as master~1 cannot be packaged, but are perfectly suitable for
82
+such as `master\~1` cannot be packaged, but are perfectly suitable for
83
defining the basis. More than one reference may be packaged, and more
84
than one basis can be specified. The objects packaged are those not
85
contained in the union of the given bases. Each basis can be
86
-specified explicitly (e.g., ^master~10), or implicitly (e.g.,
87
-master~10..master, --since=10.days.ago master).
86
+specified explicitly (e.g. `^master\~10`), or implicitly (e.g.
87
+`master\~10..master`, `--since=10.days.ago master`).
88
89
It is very important that the basis used be held by the destination.
90
-It is okay to err on the side of conservatism, causing the bundle file
91
-to contain objects already in the destination as these are ignored
90
+It is okay to err on the side of caution, causing the bundle file
91
+to contain objects already in the destination, as these are ignored
92
when unpacking at the destination.
93
94
EXAMPLE
@@ -97,13 +97,13 @@ EXAMPLE
97
Assume you want to transfer the history from a repository R1 on machine A
98
to another repository R2 on machine B.
99
For whatever reason, direct connection between A and B is not allowed,
100
-but we can move data from A to B via some mechanism (CD, email, etc).
101
-We want to update R2 with developments made on branch master in R1.
100
+but we can move data from A to B via some mechanism (CD, email, etc.).
101
+We want to update R2 with development made on the branch master in R1.
102
103
-To bootstrap the process, you can first create a bundle that doesn't have
104
-any basis. You can use a tag to remember up to what commit you sent out
105
-in order to make it easy to later update the other repository with
106
-incremental bundle,
103
+To bootstrap the process, you can first create a bundle that does not have
104
+any basis. You can use a tag to remember up to what commit you last
105
+processed, in order to make it easy to later update the other repository
106
+with an incremental bundle:
107
108
----------------
109
machineA$ cd R1
@@ -111,17 +111,17 @@ machineA$ git bundle create file.bundle master
111
machineA$ git tag -f lastR2bundle master
112
----------------
113
114
-Then you sneakernet file.bundle to the target machine B. Because you don't
115
-have to have any object to extract objects from such a bundle, not only
116
-you can fetch/pull from a bundle, you can clone from it as if it was a
117
-remote repository.
114
+Then you transfer file.bundle to the target machine B. If you are creating
115
+the repository on machine B, then you can clone from the bundle as if it
116
+were a remote repository instead of creating an empty repository and then
117
+pulling or fetching objects from the bundle:
118
119
----------------
120
machineB$ git clone /home/me/tmp/file.bundle R2
121
----------------
122
123
This will define a remote called "origin" in the resulting repository that
124
-lets you fetch and pull from the bundle. $GIT_DIR/config file in R2 may
124
+lets you fetch and pull from the bundle. The $GIT_DIR/config file in R2 will
125
have an entry like this:
126
127
------------------------
@@ -130,12 +130,12 @@ have an entry like this:
130
fetch = refs/heads/*:refs/remotes/origin/*
131
------------------------
132
133
-You can fetch/pull to update the resulting mine.git repository after
134
-replacing the bundle you store at /home/me/tmp/file.bundle with incremental
135
-updates from here on.
133
+To update the resulting mine.git repository, you can fetch or pull after
134
+replacing the bundle stored at /home/me/tmp/file.bundle with incremental
135
+updates.
136
137
-After working more in the original repository, you can create an
138
-incremental bundle to update the other:
137
+After working some more in the original repository, you can create an
138
+incremental bundle to update the other repository:
139
140
----------------
141
machineA$ cd R1
@@ -143,8 +143,8 @@ machineA$ git bundle create file.bundle lastR2bundle..master
143
machineA$ git tag -f lastR2bundle master
144
----------------
145
146
-and sneakernet it to the other machine to replace /home/me/tmp/file.bundle,
147
-and pull from it.
146
+You then transfer the bundle to the other machine to replace
147
+/home/me/tmp/file.bundle, and pull from it.
148
149
----------------
150
machineB$ cd R2
@@ -152,49 +152,49 @@ machineB$ git pull
152
----------------
153
154
If you know up to what commit the intended recipient repository should
155
-have the necessary objects for, you can use that knowledge to specify the
155
+have the necessary objects, you can use that knowledge to specify the
156
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
-for this purpose, but you can use other options you would give to
158
+for this purpose, but you can use any other options that you would give to
159
the linkgit:git-log[1] command. Here are more examples:
160
161
-You can use a tag that is present in both.
161
+You can use a tag that is present in both:
162
163
----------------
164
$ git bundle create mybundle v1.0.0..master
165
----------------
166
167
-You can use a basis based on time.
167
+You can use a basis based on time:
168
169
----------------
170
$ git bundle create mybundle --since=10.days master
171
----------------
172
173
-Or you can use the number of commits.
173
+You can use the number of commits:
174
175
----------------
176
$ git bundle create mybundle -10 master
177
----------------
178
179
You can run `git-bundle verify` to see if you can extract from a bundle
180
-that was created with a basis.
180
+that was created with a basis:
181
182
----------------
183
$ git bundle verify mybundle
184
----------------
185
186
This will list what commits you must have in order to extract from the
187
-bundle and will error out if you don't have them.
187
+bundle and will error out if you do not have them.
188
189
A bundle from a recipient repository's point of view is just like a
190
-regular repository it fetches/pulls from. You can for example map
191
-refs, like this example, when fetching:
190
+regular repository which it fetches or pulls from. You can, for example, map
191
+references when fetching:
192
193
----------------
194
$ git fetch mybundle master:localRef
195
----------------
196
197
-Or see what refs it offers.
197
+You can also see what references it offers.
198
199
----------------
200
$ git ls-remote mybundle