From dfcea4a12bb3cabc25f09fa3e5c5ec883c0e2d32 Mon Sep 17 00:00:00 2001
From: Colin Walters <walters@verbum.org>
Date: Wed, 19 Jun 2024 08:59:10 -0400
Subject: [PATCH] chunking: Add some doc comments

Just a drive by.
---
 lib/src/chunking.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lib/src/chunking.rs b/lib/src/chunking.rs
index 69593e5e..eaa22ff8 100644
--- a/lib/src/chunking.rs
+++ b/lib/src/chunking.rs
@@ -30,7 +30,10 @@ pub(crate) const MAX_CHUNKS: u32 = 64;
 /// we will just drop down to one.
 const MIN_CHUNKED_LAYERS: u32 = 4;
 
+/// A convenient alias for a reference-counted, immutable string.
 type RcStr = Rc<str>;
+/// Maps from a checksum to its size and file names (multiple in the case of
+/// hard links).
 pub(crate) type ChunkMapping = BTreeMap<RcStr, (u64, Vec<Utf8PathBuf>)>;
 // TODO type PackageSet = HashSet<RcStr>;