checksums-docs: add note on using checksums.stream

diff --git a/core/checksums/checksums-docs.factor b/core/checksums/checksums-docs.factor
index fd9e5ed26a195ae8faa21280604d0341219efac1..c387de24fae667a8747dae59b8fae209520943cd 100644 (file)
--- a/core/checksums/checksums-docs.factor
+++ b/core/checksums/checksums-docs.factor
@@ -58,6 +58,9 @@ $nl
 }
 "Checksums should implement at least one of " { $link checksum-bytes } " and " { $link checksum-stream } ". Implementing " { $link checksum-lines } " is optional."
 $nl
+"In the default implementation " { $link checksum-bytes } " is abstract, and " { $link checksum-stream } " is implemented by calling it with the stream contents fully read into memory. If you want your checksum to be the other way around, that is, "  { $link checksum-bytes } " to be implemented by calling " { $link checksum-stream } ", consider using the " { $snippet "stream-checksum" } " mixin:"
+{ $vocab-subsection "stream-checksum" "checksums.stream" }
+$nl
 "Utilities:"
 { $subsections
     checksum-file