diff options
| author | Jeff King <peff@peff.net> | 2013-07-24 04:03:13 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-07-24 15:57:01 -0700 |
| commit | af608260f6e0970a59b66cc819d35b8faa15ce13 (patch) | |
| tree | 847c279309fe61f123f03566d3eb9d3549b5a650 | |
| parent | 9354b9a4f05f3a5e6dd63438befb54dbe69295f8 (diff) | |
| download | git-af608260f6e0970a59b66cc819d35b8faa15ce13.tar.gz git-af608260f6e0970a59b66cc819d35b8faa15ce13.tar.xz | |
document 'agent' protocol capability
This was added in ff5effd (include agent identifier in
capability string, 2012-08-03), but neither the syntax nor
the semantics were ever documented outside of the commit
message.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/technical/protocol-capabilities.txt | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/Documentation/technical/protocol-capabilities.txt b/Documentation/technical/protocol-capabilities.txt index 9bc2a10f1..d35159eea 100644 --- a/Documentation/technical/protocol-capabilities.txt +++ b/Documentation/technical/protocol-capabilities.txt @@ -22,7 +22,8 @@ The 'report-status' and 'delete-refs' capabilities are sent and recognized by the receive-pack (push to server) process. The 'ofs-delta' and 'side-band-64k' capabilities are sent and recognized -by both upload-pack and receive-pack protocols. +by both upload-pack and receive-pack protocols. The 'agent' capability +may optionally be sent in both protocols. All other capabilities are only recognized by the upload-pack (fetch from server) process. @@ -123,6 +124,20 @@ Server can send, and client understand PACKv2 with delta referring to its base by position in pack rather than by an obj-id. That is, they can send/read OBJ_OFS_DELTA (aka type 6) in a packfile. +agent +----- + +The server may optionally send a capability of the form `agent=X` to +notify the client that the server is running version `X`. The client may +optionally return its own agent string by responding with an `agent=Y` +capability (but it MUST NOT do so if the server did not mention the +agent capability). The `X` and `Y` strings may contain any printable +ASCII characters except space (i.e., the byte range 32 < x < 127), and +are typically of the form "package/version" (e.g., "git/1.8.3.1"). The +agent strings are purely informative for statistics and debugging +purposes, and MUST NOT be used to programatically assume the presence +or absence of particular features. + shallow ------- |