man5/gitformat-bundle.5

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