]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Documentation: document v1 protocol object-format capability
authorbrian m. carlson <sandals@crustytoothpaste.net>
Wed, 13 May 2020 00:53:42 +0000 (00:53 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 14 May 2020 01:14:08 +0000 (18:14 -0700)
Document a capability that indicates which hash algorithms are in use by
both sides of a remote connection.  Use the term "object-format", since
this is the term used for the repository extension as well.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/protocol-capabilities.txt

index 2b267c0da6b2d88c8ab9425745b7239e3f867b6e..36ccd14f97ed4631078fbac5cf65940840d3e197 100644 (file)
@@ -176,6 +176,21 @@ agent strings are purely informative for statistics and debugging
 purposes, and MUST NOT be used to programmatically assume the presence
 or absence of particular features.
 
+object-format
+-------------
+
+This capability, which takes a hash algorithm as an argument, indicates
+that the server supports the given hash algorithms.  It may be sent
+multiple times; if so, the first one given is the one used in the ref
+advertisement.
+
+When provided by the client, this indicates that it intends to use the
+given hash algorithm to communicate.  The algorithm provided must be one
+that the server supports.
+
+If this capability is not provided, it is assumed that the only
+supported algorithm is SHA-1.
+
 symref
 ------