Documentation Common to Pack and Http Protocols =============================================== ABNF Notation ------------- ABNF notation as described by RFC 5234 is used within the protocol documents, except the following replacement core rules are used: ---- HEXDIG = DIGIT / "a" / "b" / "c" / "d" / "e" / "f" ---- We also define the following common rules: ---- NUL = %x00 zero-id = 40*"0" obj-id = 40*(HEXDIGIT) refname = "HEAD" refname /= "refs/" <see discussion below> ---- A refname is a hierarchical octet string beginning with "refs/" and not violating the 'git-check-ref-format' command's validation rules. More specifically, they: . They can include slash `/` for hierarchical (directory) grouping, but no slash-separated component can begin with a dot `.`. . They must contain at least one `/`. This enforces the presence of a category like `heads/`, `tags/` etc. but the actual names are not restricted. . They cannot have two consecutive dots `..` anywhere. . They cannot have ASCII control characters (i.e. bytes whose values are lower than \040, or \177 `DEL`), space, tilde `~`, caret `^`, colon `:`, question-mark `?`, asterisk `*`, or open bracket `[` anywhere. . They cannot end with a slash `/` nor a dot `.`. . They cannot end with the sequence `.lock`. . They cannot contain a sequence `@{`. . They cannot contain a `\\`. pkt-line Format --------------- Much (but not all) of the payload is described around pkt-lines. A pkt-line is a variable length binary string. The first four bytes of the line, the pkt-len, indicates the total length of the line, in hexadecimal. The pkt-len includes the 4 bytes used to contain the length's hexadecimal representation. A pkt-line MAY contain binary data, so implementors MUST ensure pkt-line parsing/formatting routines are 8-bit clean. A non-binary line SHOULD BE terminated by an LF, which if present MUST be included in the total length. The maximum length of a pkt-line's data component is 65520 bytes. Implementations MUST NOT send pkt-line whose length exceeds 65524 (65520 bytes of payload + 4 bytes of length data). Implementations SHOULD NOT send an empty pkt-line ("0004"). A pkt-line with a length field of 0 ("0000"), called a flush-pkt, is a special case and MUST be handled differently than an empty pkt-line ("0004"). ---- pkt-line = data-pkt / flush-pkt data-pkt = pkt-len pkt-payload pkt-len = 4*(HEXDIG) pkt-payload = (pkt-len - 4)*(OCTET) flush-pkt = "0000" ---- Examples (as C-style strings): ---- pkt-line actual value --------------------------------- "0006a\n" "a\n" "0005a" "a" "000bfoobar\n" "foobar\n" "0004" "" ----
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
api-allocation-growing.html | File | 17.55 KB | 0644 |
|
api-allocation-growing.txt | File | 1019 B | 0644 |
|
api-argv-array.html | File | 19.44 KB | 0644 |
|
api-argv-array.txt | File | 2.12 KB | 0644 |
|
api-builtin.html | File | 19.43 KB | 0644 |
|
api-builtin.txt | File | 2 KB | 0644 |
|
api-config.html | File | 23.39 KB | 0644 |
|
api-config.txt | File | 5.18 KB | 0644 |
|
api-credentials.html | File | 27.9 KB | 0644 |
|
api-credentials.txt | File | 8.87 KB | 0644 |
|
api-decorate.html | File | 16.23 KB | 0644 |
|
api-decorate.txt | File | 60 B | 0644 |
|
api-diff.html | File | 24.32 KB | 0644 |
|
api-diff.txt | File | 5.22 KB | 0644 |
|
api-directory-listing.html | File | 20.75 KB | 0644 |
|
api-directory-listing.txt | File | 2.71 KB | 0644 |
|
api-gitattributes.html | File | 21.9 KB | 0644 |
|
api-gitattributes.txt | File | 3.62 KB | 0644 |
|
api-grep.html | File | 16.31 KB | 0644 |
|
api-grep.txt | File | 76 B | 0644 |
|
api-hash.html | File | 18.42 KB | 0644 |
|
api-hash.txt | File | 1.4 KB | 0644 |
|
api-hashmap.html | File | 35.57 KB | 0644 |
|
api-hashmap.txt | File | 7.71 KB | 0644 |
|
api-history-graph.html | File | 24.08 KB | 0644 |
|
api-history-graph.txt | File | 5.9 KB | 0644 |
|
api-in-core-index.html | File | 16.96 KB | 0644 |
|
api-in-core-index.txt | File | 457 B | 0644 |
|
api-index-skel.txt | File | 431 B | 0644 |
|
api-index.html | File | 18.45 KB | 0644 |
|
api-index.sh | File | 611 B | 0644 |
|
api-index.txt | File | 1.68 KB | 0644 |
|
api-lockfile.html | File | 20.05 KB | 0644 |
|
api-lockfile.txt | File | 2.92 KB | 0644 |
|
api-merge.html | File | 21.36 KB | 0644 |
|
api-merge.txt | File | 3.3 KB | 0644 |
|
api-object-access.html | File | 16.73 KB | 0644 |
|
api-object-access.txt | File | 342 B | 0644 |
|
api-parse-options.html | File | 31.03 KB | 0644 |
|
api-parse-options.txt | File | 9.36 KB | 0644 |
|
api-quote.html | File | 16.42 KB | 0644 |
|
api-quote.txt | File | 145 B | 0644 |
|
api-ref-iteration.html | File | 19.71 KB | 0644 |
|
api-ref-iteration.txt | File | 2.41 KB | 0644 |
|
api-remote.html | File | 21.26 KB | 0644 |
|
api-remote.txt | File | 3.3 KB | 0644 |
|
api-revision-walking.html | File | 19.76 KB | 0644 |
|
api-revision-walking.txt | File | 2.39 KB | 0644 |
|
api-run-command.html | File | 28.25 KB | 0644 |
|
api-run-command.txt | File | 8.08 KB | 0644 |
|
api-setup.html | File | 16.51 KB | 0644 |
|
api-setup.txt | File | 180 B | 0644 |
|
api-sha1-array.html | File | 19.39 KB | 0644 |
|
api-sha1-array.txt | File | 2.25 KB | 0644 |
|
api-sigchain.html | File | 17.74 KB | 0644 |
|
api-sigchain.txt | File | 1.34 KB | 0644 |
|
api-strbuf.html | File | 32.15 KB | 0644 |
|
api-strbuf.txt | File | 10.17 KB | 0644 |
|
api-string-list.html | File | 26.42 KB | 0644 |
|
api-string-list.txt | File | 6.84 KB | 0644 |
|
api-tree-walking.html | File | 23.17 KB | 0644 |
|
api-tree-walking.txt | File | 4.27 KB | 0644 |
|
api-xdiff-interface.html | File | 16.3 KB | 0644 |
|
api-xdiff-interface.txt | File | 139 B | 0644 |
|
index-format.html | File | 27.12 KB | 0644 |
|
index-format.txt | File | 6.29 KB | 0644 |
|
pack-format.html | File | 24.08 KB | 0644 |
|
pack-format.txt | File | 5.54 KB | 0644 |
|
pack-heuristics.html | File | 42.74 KB | 0644 |
|
pack-heuristics.txt | File | 17.77 KB | 0644 |
|
pack-protocol.html | File | 43.12 KB | 0644 |
|
pack-protocol.txt | File | 20.99 KB | 0644 |
|
protocol-capabilities.html | File | 25.41 KB | 0644 |
|
protocol-capabilities.txt | File | 7.09 KB | 0644 |
|
protocol-common.html | File | 20.08 KB | 0644 |
|
protocol-common.txt | File | 2.7 KB | 0644 |
|
racy-git.html | File | 26.85 KB | 0644 |
|
racy-git.txt | File | 8.63 KB | 0644 |
|
send-pack-pipeline.html | File | 18.73 KB | 0644 |
|
send-pack-pipeline.txt | File | 1.92 KB | 0644 |
|
shallow.html | File | 18.86 KB | 0644 |
|
shallow.txt | File | 2.3 KB | 0644 |
|
trivial-merge.html | File | 21.62 KB | 0644 |
|
trivial-merge.txt | File | 4.16 KB | 0644 |
|