From: Masaya Suzuki <masayasuzuki@google.com>
To: git@vger.kernel.org
Cc: Masaya Suzuki <masayasuzuki@google.com>
Subject: [PATCH] doc: describe Git bundle format
Date: Thu, 30 Jan 2020 14:58:18 -0800 [thread overview]
Message-ID: <20200130225818.193825-1-masayasuzuki@google.com> (raw)
The bundle format was not documented. Describe the format with ABNF and
explain the meaning of each part.
Signed-off-by: Masaya Suzuki <masayasuzuki@google.com>
---
Documentation/technical/bundle-format.txt | 40 +++++++++++++++++++++++
1 file changed, 40 insertions(+)
create mode 100644 Documentation/technical/bundle-format.txt
diff --git a/Documentation/technical/bundle-format.txt b/Documentation/technical/bundle-format.txt
new file mode 100644
index 0000000000..dbb80225b5
--- /dev/null
+++ b/Documentation/technical/bundle-format.txt
@@ -0,0 +1,40 @@
+= Git bundle v2 format
+
+The Git bundle format is a format that represents both refs and Git objects.
+
+== Format
+
+We will use ABNF notation to define the Git bundle format. See
+protocol-common.txt for the details.
+
+----
+bundle = signature references pack
+signature = "# v2 git bundle" LF
+
+references = *(prerequisite / ref) LF
+prerequisite = "-" obj-id SP comment LF
+comment = *CHAR
+ref = obj-id SP refname LF
+
+pack = ... ; packfile
+----
+
+== Semantics
+
+A Git bundle consists of three parts.
+
+* Prerequisites: Optional list of objects that are not included in the bundle
+ file. A bundle can reference these prerequisite objects (or it can reference
+ the objects reachable from the prerequisite objects). The bundle itself
+ might not contain those objects.
+* References: Mapping of ref names to objects.
+* Git objects: Commit, tree, blob, and tags. These are included in the pack
+ format.
+
+If a bundle contains prerequisites, it means the bundle has a thin pack and the
+bundle alone is not enough for resolving all objects. When you read such
+bundles, you should have those missing objects beforehand.
+
+In the bundle format, there can be a comment following a prerequisite obj-id.
+This is a comment and it has no specific meaning. When you write a bundle, you
+can put any string here. When you read a bundle, you can ignore this part.
--
2.25.0.341.g760bfbb309-goog
next reply other threads:[~2020-01-30 22:58 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-30 22:58 Masaya Suzuki [this message]
2020-01-31 13:56 ` [PATCH] doc: describe Git bundle format Johannes Schindelin
2020-01-31 20:38 ` Junio C Hamano
2020-01-31 21:49 ` Masaya Suzuki
2020-01-31 23:01 ` Junio C Hamano
2020-01-31 23:57 ` Masaya Suzuki
2020-02-04 18:20 ` Junio C Hamano
2020-01-31 22:18 ` [PATCH v2] " Masaya Suzuki
2020-01-31 23:06 ` Junio C Hamano
2020-02-07 20:42 ` [PATCH v3] " Masaya Suzuki
2020-02-07 20:44 ` Masaya Suzuki
2020-02-07 20:59 ` Junio C Hamano
2020-02-07 22:21 ` Masaya Suzuki
2020-02-08 1:49 ` Junio C Hamano
2020-02-12 22:13 ` Masaya Suzuki
2020-02-12 22:43 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200130225818.193825-1-masayasuzuki@google.com \
--to=masayasuzuki@google.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.