summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKim Altintop <kim@eagain.io>2023-04-13 17:09:37 +0200
committerKim Altintop <kim@eagain.io>2023-04-13 17:10:23 +0200
commit0e40f259cf703fe4500c94f6e05efa69d5388438 (patch)
tree2f63c62e8dfb175cea7e691f5842a24e4cfeaab7
parent8ce1155a1eb490625a7e949a10c4283b4b773d30 (diff)
doc: update spec on BLAKE3 bundle checksum
Signed-off-by: Kim Altintop <kim@eagain.io>
-rw-r--r--Documentation/spec.adoc9
1 files changed, 8 insertions, 1 deletions
diff --git a/Documentation/spec.adoc b/Documentation/spec.adoc
index 10e552e..fca2fe1 100644
--- a/Documentation/spec.adoc
+++ b/Documentation/spec.adoc
@@ -54,6 +54,13 @@ Normally, identities must be resolvable within the same tree as the drop \
metadata. However, resolution may be substituted if e.g. the client believes \
to have more up-to-date identity data elsewhere. \
]
+:fn-blake3: footnote:blake3[ \
+BLAKE3 is a tree hash which remains stable in verified streaming mode (Bao), \
+even with variable chunk sizes. This means that it is a good choice for \
+long-term content addressability, in particular in location-independent \
+storage. We don't use BLAKE3 elsewhere, however, in order to maximise \
+compatibility with git. \
+]
//
@@ -1011,7 +1018,7 @@ are:
bundles, i.e. both the prerequisites and reference heads.
[[BUNDLE_CHECKSUM]]BUNDLE_CHECKSUM::
- SHA-256 hash over the bundle file as received.
+ BLAKE3 hash over the bundle file as received{fn-blake3}.
[[BUNDLE_SIGNATURE]]BUNDLE_SIGNATURE::
Signature over the <<BUNDLE_HEADS>>, in hexadecimal.