blob: 5c4a4d444d210dbb3a0659c901aebf15816c5ef6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
'\" t
.\" Title: gitformat-bundle
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 2024-04-16
.\" Manual: Git Manual
.\" Source: Git 2.44.0.651.g21306a098c
.\" Language: English
.\"
.TH "GITFORMAT\-BUNDLE" "5" "2024\-04\-16" "Git 2\&.44\&.0\&.651\&.g21306a" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gitformat-bundle \- The bundle file format
.SH "SYNOPSIS"
.sp
.nf
*\&.bundle
*\&.bdl
.fi
.sp
.SH "DESCRIPTION"
.sp
The Git bundle format is a format that represents both refs and Git objects\&. A bundle is a header in a format similar to \fBgit-show-ref\fR(1) followed by a pack in *\&.pack format\&.
.sp
The format is created and read by the \fBgit-bundle\fR(1) command, and supported by e\&.g\&. \fBgit-fetch\fR(1) and \fBgit-clone\fR(1)\&.
.SH "FORMAT"
.sp
We will use ABNF notation to define the Git bundle format\&. See \fBgitprotocol-common\fR(5) for the details\&.
.sp
A v2 bundle looks like this:
.sp
.if n \{\
.RS 4
.\}
.nf
bundle = signature *prerequisite *reference LF pack
signature = "# v2 git bundle" LF
prerequisite = "\-" obj\-id SP comment LF
comment = *CHAR
reference = obj\-id SP refname LF
pack = \&.\&.\&. ; packfile
.fi
.if n \{\
.RE
.\}
.sp
.sp
A v3 bundle looks like this:
.sp
.if n \{\
.RS 4
.\}
.nf
bundle = signature *capability *prerequisite *reference LF pack
signature = "# v3 git bundle" LF
capability = "@" key ["=" value] LF
prerequisite = "\-" obj\-id SP comment LF
comment = *CHAR
reference = obj\-id SP refname LF
key = 1*(ALPHA / DIGIT / "\-")
value = *(%01\-09 / %0b\-FF)
pack = \&.\&.\&. ; packfile
.fi
.if n \{\
.RE
.\}
.sp
.SH "SEMANTICS"
.sp
A Git bundle consists of several parts\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"Capabilities", which are only in the v3 format, indicate functionality that the bundle requires to be read properly\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"Prerequisites" list the objects that are NOT included in the bundle and the reader of the bundle MUST already have, in order to use the data in the bundle\&. The objects stored in the bundle may refer to prerequisite objects and anything reachable from them (e\&.g\&. a tree object in the bundle can reference a blob that is reachable from a prerequisite) and/or expressed as a delta against prerequisite objects\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"References" record the tips of the history graph, iow, what the reader of the bundle CAN "git fetch" from it\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"Pack" is the pack data stream "git fetch" would send, if you fetch from a repository that has the references recorded in the "References" above into a repository that has references pointing at the objects listed in "Prerequisites" above\&.
.RE
.sp
In the bundle format, there can be a comment following a prerequisite obj\-id\&. This is a comment and it has no specific meaning\&. The writer of the bundle MAY put any string here\&. The reader of the bundle MUST ignore the comment\&.
.SS "Note on shallow clones and Git bundles"
.sp
Note that the prerequisites do not represent a shallow\-clone boundary\&. The semantics of the prerequisites and the shallow\-clone boundaries are different, and the Git bundle v2 format cannot represent a shallow clone repository\&.
.SH "CAPABILITIES"
.sp
Because there is no opportunity for negotiation, unknown capabilities cause \fIgit bundle\fR to abort\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBobject\-format\fR
specifies the hash algorithm in use, and can take the same values as the
\fBextensions\&.objectFormat\fR
configuration value\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBfilter\fR
specifies an object filter as in the
\fB\-\-filter\fR
option in
\fBgit-rev-list\fR(1)\&. The resulting pack\-file must be marked as a
\fB\&.promisor\fR
pack\-file after it is unbundled\&.
.RE
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite
|
