some more docs for 'pack' module

Author: Byron

git-odb/src/loose/db/mod.rs

@@ -1,6 +1,7 @@
 use git_object::{borrowed, HashKind};
 use std::path::PathBuf;
 
+/// A database for reading and writing objects to disk, one file per object.
 pub struct Db {
     pub path: PathBuf,
 }

git-odb/src/pack/bundle/mod.rs

@@ -17,14 +17,17 @@ pub enum Error {
     Index(#[from] pack::index::init::Error),
 }
 
-/// A packfile with an index
+/// A bundle of pack data and the corresponding pack index
 pub struct Bundle {
     pub pack: pack::data::File,
     pub index: pack::index::File,
 }
 
+/// Initialization
 impl Bundle {
-    /// `path` is either a pack file or an index file
+    /// Create a `Bundle` from `path`, which is either a pack file _(*.pack)_ or an index file _(*.idx)_.
+    ///
+    /// The corresponding complementary file is expected to be present.
     pub fn at(path: impl AsRef<Path>) -> Result<Self, Error> {
         Self::try_from(path.as_ref())
     }

git-odb/src/pack/bundle/write/mod.rs

@@ -16,6 +16,8 @@ mod types;
 pub use types::Outcome;
 use types::PassThrough;
 
+/// Configuration for [write_stream_to_directory][pack::Bundle::write_stream_to_directory()] or
+/// [write_to_directory_eagerly][pack::Bundle::write_to_directory_eagerly()]
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
 #[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
 pub struct Options {

git-odb/src/pack/bundle/write/types.rs

@@ -2,6 +2,8 @@ use crate::pack;
 use std::{io, path::PathBuf, sync::Arc};
 use tempfile::NamedTempFile;
 
+/// Returned by [write_stream_to_directory][pack::Bundle::write_stream_to_directory()] or
+/// [write_to_directory_eagerly][pack::Bundle::write_to_directory_eagerly()]
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
 #[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
 pub struct Outcome {

git-odb/src/pack/mod.rs

@@ -1,3 +1,4 @@
+//! Handle packs and pack indices
 pub mod bundle;
 pub mod cache;
 pub mod data;