SYNOPSIS

*.bundle
*.bdl

DESCRIPTION

Git バンドル形式は、 ref と Git オブジェクトの両方を表す形式です。 バンドルは、 git-show-ref(1) のような形式のヘッダーの後に *.pack 形式のパックが続きます。

この形式は git-bundle(1) コマンドで作成・読み込みができ、 git-fetch(1) や git-clone(1) などでサポートされています。

FORMAT

ABNF 記法を使用して Git バンドル形式を定義します。 詳細については、gitprotocol-common(5) を参照してください。

v2バンドルは以下のようになります:

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

v3バンドルは以下のようになります:

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

SEMANTICS

Gitバンドルはいくつかの部分で構成されています。

  • capabilities (機能)はv3形式のみであり、バンドルを正しく読み取るために必要な機能を示します。

  • "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.

  • references には、履歴グラフのヒントが記録されています。つまり、バンドルのリーダーがそこから `git fetch ` できるモノです。

  • pack は、上記の「references」に記録された参照を持つリポジトリから、上記の「prerequisites」にリストされたオブジェクトを指す参照を持つリポジトリにフェッチする場合に、 git fetch が送信するパックデータストリームです。

バンドル形式では、前提条件(prerequisite)の obj-id の後にコメントを付けることができます。 これはコメントであり、特別な意味はありません。 バンドルの作成者は、ここに任意の文字列を入れてもいいです。 バンドルのリーダーはコメントを無視しなければなりません。

Note on shallow clones and Git bundles

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.

CAPABILITIES

不明な機能は、 交渉(negotiation)の機会がないため、 git bundle の中止(abort)を引き起こします。

  • object-format には使用中のハッシュ・アルゴリズムを指定し、 extensions.objectFormat 構成値と同じ値を取ることができます。

  • filter は、git-rev-list(1) の --filter オプションのようにオブジェクト・フィルタを指定します。 生成されたパック・ファイルは、バンドル解除(unbundle)後に .promisor パック・ファイルとしてマークする必要があります。

GIT

Part of the git(1) suite