]>
Commit | Line | Data |
---|---|---|
2e0afafe JS |
1 | git-bundle(1) |
2 | ============= | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-bundle - Move objects and refs by archive | |
7 | ||
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
e448ff87 | 11 | [verse] |
8b95521e | 12 | 'git bundle' create [-q | --quiet | --progress] |
c5aecfc8 | 13 | [--version=<version>] <file> <git-rev-list-args> |
e0eba649 | 14 | 'git bundle' verify [-q | --quiet] <file> |
62b4698e | 15 | 'git bundle' list-heads <file> [<refname>...] |
d941cc4c | 16 | 'git bundle' unbundle [--progress] <file> [<refname>...] |
2e0afafe JS |
17 | |
18 | DESCRIPTION | |
19 | ----------- | |
20 | ||
5c8273d5 ÆAB |
21 | Create, unpack, and manipulate "bundle" files. Bundles are used for |
22 | the "offline" transfer of Git objects without an active "server" | |
23 | sitting on the other side of the network connection. | |
24 | ||
25 | They can be used to create both incremental and full backups of a | |
26 | repository, and to relay the state of the references in one repository | |
27 | to another. | |
28 | ||
29 | Git commands that fetch or otherwise "read" via protocols such as | |
30 | `ssh://` and `https://` can also operate on bundle files. It is | |
31 | possible linkgit:git-clone[1] a new repository from a bundle, to use | |
32 | linkgit:git-fetch[1] to fetch from one, and to list the references | |
33 | contained within it with linkgit:git-ls-remote[1]. There's no | |
34 | corresponding "write" support, i.e.a 'git push' into a bundle is not | |
35 | supported. | |
36 | ||
37 | See the "EXAMPLES" section below for examples of how to use bundles. | |
38 | ||
39 | BUNDLE FORMAT | |
40 | ------------- | |
41 | ||
42 | Bundles are `.pack` files (see linkgit:git-pack-objects[1]) with a | |
43 | header indicating what references are contained within the bundle. | |
44 | ||
c9dba103 | 45 | Like the packed archive format itself bundles can either be |
5c8273d5 | 46 | self-contained, or be created using exclusions. |
9ab80dd6 | 47 | See the "OBJECT PREREQUISITES" section below. |
5c8273d5 ÆAB |
48 | |
49 | Bundles created using revision exclusions are "thin packs" created | |
50 | using the `--thin` option to linkgit:git-pack-objects[1], and | |
51 | unbundled using the `--fix-thin` option to linkgit:git-index-pack[1]. | |
52 | ||
53 | There is no option to create a "thick pack" when using revision | |
a4dfb449 MÅ |
54 | exclusions, and users should not be concerned about the difference. By |
55 | using "thin packs", bundles created using exclusions are smaller in | |
5c8273d5 | 56 | size. That they're "thin" under the hood is merely noted here as a |
a4dfb449 | 57 | curiosity, and as a reference to other documentation. |
5c8273d5 | 58 | |
844739ba | 59 | See linkgit:gitformat-bundle[5] for more details and the discussion of |
977c47b4 | 60 | "thin pack" in linkgit:gitformat-pack[5] for further details. |
2e0afafe JS |
61 | |
62 | OPTIONS | |
63 | ------- | |
64 | ||
79862b6b | 65 | create [options] <file> <git-rev-list-args>:: |
a6190565 | 66 | Used to create a bundle named 'file'. This requires the |
0e40a73a | 67 | '<git-rev-list-args>' arguments to define the bundle contents. |
79862b6b | 68 | 'options' contains the options specific to the 'git bundle create' |
ef3b291a | 69 | subcommand. If 'file' is `-`, the bundle is written to stdout. |
2e0afafe JS |
70 | |
71 | verify <file>:: | |
a6190565 MG |
72 | Used to check that a bundle file is valid and will apply |
73 | cleanly to the current repository. This includes checks on the | |
74 | bundle format itself as well as checking that the prerequisite | |
75 | commits exist and are fully linked in the current repository. | |
017303eb DS |
76 | Then, 'git bundle' prints a list of missing commits, if any. |
77 | Finally, information about additional capabilities, such as "object | |
844739ba | 78 | filter", is printed. See "Capabilities" in linkgit:gitformat-bundle[5] |
017303eb | 79 | for more information. The exit code is zero for success, but will |
ef3b291a JK |
80 | be nonzero if the bundle file is invalid. If 'file' is `-`, the |
81 | bundle is read from stdin. | |
2e0afafe JS |
82 | |
83 | list-heads <file>:: | |
a6190565 MG |
84 | Lists the references defined in the bundle. If followed by a |
85 | list of references, only references matching those given are | |
ef3b291a | 86 | printed out. If 'file' is `-`, the bundle is read from stdin. |
2e0afafe JS |
87 | |
88 | unbundle <file>:: | |
a6190565 MG |
89 | Passes the objects in the bundle to 'git index-pack' |
90 | for storage in the repository, then prints the names of all | |
91 | defined references. If a list of references is given, only | |
92 | references matching those in the list are printed. This command is | |
93 | really plumbing, intended to be called only by 'git fetch'. | |
ef3b291a | 94 | If 'file' is `-`, the bundle is read from stdin. |
2e0afafe | 95 | |
5e1f9605 | 96 | <git-rev-list-args>:: |
a6190565 | 97 | A list of arguments, acceptable to 'git rev-parse' and |
469bfc96 | 98 | 'git rev-list' (and containing a named ref, see SPECIFYING REFERENCES |
1884df1a | 99 | below), that specifies the specific objects and references |
6cf378f0 | 100 | to transport. For example, `master~10..master` causes the |
a6190565 MG |
101 | current master reference to be packaged along with all objects |
102 | added since its 10th ancestor commit. There is no explicit | |
103 | limit to the number of references and objects that may be | |
104 | packaged. | |
2e0afafe JS |
105 | |
106 | ||
62b4698e | 107 | [<refname>...]:: |
a6190565 MG |
108 | A list of references used to limit the references reported as |
109 | available. This is principally of use to 'git fetch', which | |
110 | expects to receive only those references asked for and not | |
111 | necessarily everything in the pack (in this case, 'git bundle' acts | |
112 | like 'git fetch-pack'). | |
2e0afafe | 113 | |
79862b6b RJ |
114 | --progress:: |
115 | Progress status is reported on the standard error stream | |
116 | by default when it is attached to a terminal, unless -q | |
117 | is specified. This flag forces progress status even if | |
118 | the standard error stream is not directed to a terminal. | |
119 | ||
c5aecfc8 | 120 | --version=<version>:: |
121 | Specify the bundle version. Version 2 is the older format and can only be | |
122 | used with SHA-1 repositories; the newer version 3 contains capabilities that | |
123 | permit extensions. The default is the oldest supported format, based on the | |
124 | hash algorithm in use. | |
125 | ||
79862b6b RJ |
126 | -q:: |
127 | --quiet:: | |
128 | This flag makes the command not to report its progress | |
129 | on the standard error stream. | |
130 | ||
2e0afafe JS |
131 | SPECIFYING REFERENCES |
132 | --------------------- | |
133 | ||
a4dfb449 | 134 | Revisions must be accompanied by reference names to be packaged in a |
0bb92f3a ÆAB |
135 | bundle. |
136 | ||
1d9c8dae | 137 | More than one reference may be packaged, and more than one set of prerequisite objects can |
0bb92f3a | 138 | be specified. The objects packaged are those not contained in the |
1d9c8dae | 139 | union of the prerequisites. |
0bb92f3a ÆAB |
140 | |
141 | The 'git bundle create' command resolves the reference names for you | |
142 | using the same rules as `git rev-parse --abbrev-ref=loose`. Each | |
1d9c8dae | 143 | prerequisite can be specified explicitly (e.g. `^master~10`), or implicitly |
0bb92f3a ÆAB |
144 | (e.g. `master~10..master`, `--since=10.days.ago master`). |
145 | ||
146 | All of these simple cases are OK (assuming we have a "master" and | |
147 | "next" branch): | |
148 | ||
149 | ---------------- | |
150 | $ git bundle create master.bundle master | |
151 | $ echo master | git bundle create master.bundle --stdin | |
152 | $ git bundle create master-and-next.bundle master next | |
153 | $ (echo master; echo next) | git bundle create master-and-next.bundle --stdin | |
154 | ---------------- | |
155 | ||
156 | And so are these (and the same but omitted `--stdin` examples): | |
157 | ||
158 | ---------------- | |
159 | $ git bundle create recent-master.bundle master~10..master | |
160 | $ git bundle create recent-updates.bundle master~10..master next~5..next | |
161 | ---------------- | |
162 | ||
163 | A revision name or a range whose right-hand-side cannot be resolved to | |
164 | a reference is not accepted: | |
165 | ||
166 | ---------------- | |
167 | $ git bundle create HEAD.bundle $(git rev-parse HEAD) | |
168 | fatal: Refusing to create empty bundle. | |
169 | $ git bundle create master-yesterday.bundle master~10..master~5 | |
170 | fatal: Refusing to create empty bundle. | |
171 | ---------------- | |
2e0afafe | 172 | |
9ab80dd6 ÆAB |
173 | OBJECT PREREQUISITES |
174 | -------------------- | |
175 | ||
176 | When creating bundles it is possible to create a self-contained bundle | |
177 | that can be unbundled in a repository with no common history, as well | |
178 | as providing negative revisions to exclude objects needed in the | |
179 | earlier parts of the history. | |
180 | ||
181 | Feeding a revision such as `new` to `git bundle create` will create a | |
182 | bundle file that contains all the objects reachable from the revision | |
183 | `new`. That bundle can be unbundled in any repository to obtain a full | |
184 | history that leads to the revision `new`: | |
185 | ||
186 | ---------------- | |
187 | $ git bundle create full.bundle new | |
188 | ---------------- | |
189 | ||
190 | A revision range such as `old..new` will produce a bundle file that | |
191 | will require the revision `old` (and any objects reachable from it) | |
192 | to exist for the bundle to be "unbundle"-able: | |
193 | ||
194 | ---------------- | |
195 | $ git bundle create full.bundle old..new | |
196 | ---------------- | |
197 | ||
198 | A self-contained bundle without any prerequisites can be extracted | |
199 | into anywhere, even into an empty repository, or be cloned from | |
200 | (i.e., `new`, but not `old..new`). | |
201 | ||
1d52b026 DM |
202 | It is okay to err on the side of caution, causing the bundle file |
203 | to contain objects already in the destination, as these are ignored | |
2e0afafe JS |
204 | when unpacking at the destination. |
205 | ||
0e40a73a PO |
206 | If you want to match `git clone --mirror`, which would include your |
207 | refs such as `refs/remotes/*`, use `--all`. | |
208 | If you want to provide the same set of refs that a clone directly | |
209 | from the source repository would get, use `--branches --tags` for | |
210 | the `<git-rev-list-args>`. | |
211 | ||
9ab80dd6 ÆAB |
212 | The 'git bundle verify' command can be used to check whether your |
213 | recipient repository has the required prerequisite commits for a | |
214 | bundle. | |
215 | ||
76a8788c NTND |
216 | EXAMPLES |
217 | -------- | |
2e0afafe | 218 | |
8aa7eebf NS |
219 | Assume you want to transfer the history from a repository R1 on machine A |
220 | to another repository R2 on machine B. | |
2e0afafe | 221 | For whatever reason, direct connection between A and B is not allowed, |
1d52b026 DM |
222 | but we can move data from A to B via some mechanism (CD, email, etc.). |
223 | We want to update R2 with development made on the branch master in R1. | |
99d8ea2c | 224 | |
1d52b026 | 225 | To bootstrap the process, you can first create a bundle that does not have |
1d9c8dae | 226 | any prerequisites. You can use a tag to remember up to what commit you last |
1d52b026 DM |
227 | processed, in order to make it easy to later update the other repository |
228 | with an incremental bundle: | |
99d8ea2c | 229 | |
8aa7eebf NS |
230 | ---------------- |
231 | machineA$ cd R1 | |
ffe4da15 | 232 | machineA$ git bundle create file.bundle master |
8aa7eebf NS |
233 | machineA$ git tag -f lastR2bundle master |
234 | ---------------- | |
99d8ea2c | 235 | |
b5fb4770 JH |
236 | Then you transfer file.bundle to the target machine B. Because this |
237 | bundle does not require any existing object to be extracted, you can | |
238 | create a new repository on machine B by cloning from it: | |
99d8ea2c | 239 | |
8aa7eebf | 240 | ---------------- |
ded6aa6b | 241 | machineB$ git clone -b master /home/me/tmp/file.bundle R2 |
8aa7eebf | 242 | ---------------- |
2e0afafe | 243 | |
8aa7eebf | 244 | This will define a remote called "origin" in the resulting repository that |
1d52b026 | 245 | lets you fetch and pull from the bundle. The $GIT_DIR/config file in R2 will |
8aa7eebf | 246 | have an entry like this: |
2e0afafe | 247 | |
8aa7eebf NS |
248 | ------------------------ |
249 | [remote "origin"] | |
ffe4da15 | 250 | url = /home/me/tmp/file.bundle |
8aa7eebf NS |
251 | fetch = refs/heads/*:refs/remotes/origin/* |
252 | ------------------------ | |
253 | ||
1d52b026 DM |
254 | To update the resulting mine.git repository, you can fetch or pull after |
255 | replacing the bundle stored at /home/me/tmp/file.bundle with incremental | |
256 | updates. | |
8aa7eebf | 257 | |
1d52b026 DM |
258 | After working some more in the original repository, you can create an |
259 | incremental bundle to update the other repository: | |
8aa7eebf NS |
260 | |
261 | ---------------- | |
262 | machineA$ cd R1 | |
ffe4da15 | 263 | machineA$ git bundle create file.bundle lastR2bundle..master |
8aa7eebf NS |
264 | machineA$ git tag -f lastR2bundle master |
265 | ---------------- | |
266 | ||
1d52b026 DM |
267 | You then transfer the bundle to the other machine to replace |
268 | /home/me/tmp/file.bundle, and pull from it. | |
8aa7eebf NS |
269 | |
270 | ---------------- | |
271 | machineB$ cd R2 | |
272 | machineB$ git pull | |
273 | ---------------- | |
99d8ea2c | 274 | |
8aa7eebf | 275 | If you know up to what commit the intended recipient repository should |
1d52b026 | 276 | have the necessary objects, you can use that knowledge to specify the |
1d9c8dae | 277 | prerequisites, giving a cut-off point to limit the revisions and objects that go |
5e1f9605 | 278 | in the resulting bundle. The previous example used the lastR2bundle tag |
1d52b026 | 279 | for this purpose, but you can use any other options that you would give to |
8aa7eebf | 280 | the linkgit:git-log[1] command. Here are more examples: |
99d8ea2c | 281 | |
1d52b026 | 282 | You can use a tag that is present in both: |
99d8ea2c | 283 | |
8aa7eebf NS |
284 | ---------------- |
285 | $ git bundle create mybundle v1.0.0..master | |
286 | ---------------- | |
2e0afafe | 287 | |
1d9c8dae | 288 | You can use a prerequisite based on time: |
ee8245b5 | 289 | |
8aa7eebf NS |
290 | ---------------- |
291 | $ git bundle create mybundle --since=10.days master | |
292 | ---------------- | |
2e0afafe | 293 | |
1d52b026 | 294 | You can use the number of commits: |
2e0afafe | 295 | |
8aa7eebf NS |
296 | ---------------- |
297 | $ git bundle create mybundle -10 master | |
298 | ---------------- | |
299 | ||
300 | You can run `git-bundle verify` to see if you can extract from a bundle | |
1d9c8dae | 301 | that was created with a prerequisite: |
8aa7eebf NS |
302 | |
303 | ---------------- | |
b1889c36 | 304 | $ git bundle verify mybundle |
8aa7eebf | 305 | ---------------- |
2e0afafe | 306 | |
8aa7eebf | 307 | This will list what commits you must have in order to extract from the |
1d52b026 | 308 | bundle and will error out if you do not have them. |
2e0afafe | 309 | |
8aa7eebf | 310 | A bundle from a recipient repository's point of view is just like a |
1d52b026 DM |
311 | regular repository which it fetches or pulls from. You can, for example, map |
312 | references when fetching: | |
2e0afafe | 313 | |
8aa7eebf NS |
314 | ---------------- |
315 | $ git fetch mybundle master:localRef | |
316 | ---------------- | |
2e0afafe | 317 | |
5e1f9605 | 318 | You can also see what references it offers: |
2e0afafe | 319 | |
8aa7eebf NS |
320 | ---------------- |
321 | $ git ls-remote mybundle | |
322 | ---------------- | |
2e0afafe | 323 | |
844739ba ÆAB |
324 | FILE FORMAT |
325 | ----------- | |
326 | ||
327 | See linkgit:gitformat-bundle[5]. | |
328 | ||
2e0afafe JS |
329 | GIT |
330 | --- | |
9e1f0a85 | 331 | Part of the linkgit:git[1] suite |