[git-pack] fix docs

Author: Byron

git-features/src/zlib/stream/deflate/mod.rs

@@ -2,7 +2,7 @@ use flate2::Compress;
 
 const BUF_SIZE: usize = 4096 * 8;
 
-/// A utility to zlib compress anything that is written via its [io::Write] implementation.
+/// A utility to zlib compress anything that is written via its [Write][std::io::Write] implementation.
 ///
 /// Be sure to call `flush()` when done to finalize the deflate stream.
 pub struct Write<W> {

git-pack/src/bundle/find.rs

@@ -3,7 +3,7 @@ use crate::data;
 impl crate::Bundle {
     /// Find an object with the given [`ObjectId`][git_hash::ObjectId] and place its data into `out`.
     ///
-    /// [`cache`][pack::cache::DecodeEntry] is used to accelerate the lookup.
+    /// [`cache`][crate::cache::DecodeEntry] is used to accelerate the lookup.
     ///
     /// **Note** that ref deltas are automatically resolved within this pack only, which makes this implementation unusable
     /// for thin packs, which by now are expected to be resolved already.

git-pack/src/bundle/mod.rs

@@ -11,7 +11,7 @@ mod verify {
     use git_features::progress::Progress;
 
     impl super::Bundle {
-        /// Similar to [`pack::index::File::verify_integrity()`] but more convenient to call as the presence of the
+        /// Similar to [`crate::index::File::verify_integrity()`] but more convenient to call as the presence of the
         /// pack file is a given.
         pub fn verify_integrity<C, P>(
             &self,

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

@@ -66,7 +66,7 @@ impl crate::Bundle {
         })
     }
 
-    /// Equivalent to [`write_to_directory()`][pack::Bundle::write_to_directory()] but offloads reading of the pack into its own thread, hence the `Send + 'static'` bounds.
+    /// Equivalent to [`write_to_directory()`][crate::Bundle::write_to_directory()] but offloads reading of the pack into its own thread, hence the `Send + 'static'` bounds.
     pub fn write_to_directory_eagerly(
         pack: impl io::Read + Send + 'static,
         pack_size: Option<u64>,

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

@@ -1,16 +1,16 @@
 use std::{io, path::PathBuf, sync::Arc};
 use tempfile::NamedTempFile;
 
-/// Configuration for [write_to_directory][pack::Bundle::write_to_directory()] or
-/// [write_to_directory_eagerly][pack::Bundle::write_to_directory_eagerly()]
+/// Configuration for [write_to_directory][crate::Bundle::write_to_directory()] or
+/// [write_to_directory_eagerly][crate::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 {
     /// The amount of threads to use at most when resolving the pack. If `None`, all logical cores are used.
     pub thread_limit: Option<usize>,
     /// Determine how much processing to spend on protecting against corruption or recovering from errors.
     pub iteration_mode: crate::data::input::Mode,
-    /// The version of pack index to write, should be [`pack::index::Version::default()`]
+    /// The version of pack index to write, should be [`crate::index::Version::default()`]
     pub index_kind: crate::index::Version,
 }
 
@@ -25,8 +25,8 @@ impl Default for Options {
     }
 }
 
-/// Returned by [write_to_directory][pack::Bundle::write_to_directory()] or
-/// [write_to_directory_eagerly][pack::Bundle::write_to_directory_eagerly()]
+/// Returned by [write_to_directory][crate::Bundle::write_to_directory()] or
+/// [write_to_directory_eagerly][crate::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-pack/src/data/file/decode_entry.rs

@@ -97,7 +97,7 @@ impl File {
         );
     }
 
-    /// Obtain the [`Entry`][pack::data::Entry] at the given `offset` into the pack.
+    /// Obtain the [`Entry`][crate::data::Entry] at the given `offset` into the pack.
     ///
     /// The `offset` is typically obtained from the pack index file.
     pub fn entry(&self, offset: u64) -> crate::data::Entry {

git-pack/src/data/input/iter.rs

@@ -8,7 +8,7 @@ use std::{fs, io};
 
 /// An iterator over [`Entries`][input::Entry] in a byte stream.
 ///
-/// The iterator used as part of [Bundle::write_to_directory(…)][pack::Bundle::write_to_directory()].
+/// The iterator used as part of [Bundle::write_to_directory(…)][crate::Bundle::write_to_directory()].
 pub struct BytesToEntriesIter<R> {
     read: R,
     decompressor: Option<Box<Decompress>>,
@@ -268,7 +268,7 @@ where
 }
 
 impl crate::data::File {
-    /// Returns an iterator over [`Entries`][pack::data::input::Entry], without making use of the memory mapping.
+    /// Returns an iterator over [`Entries`][crate::data::input::Entry], without making use of the memory mapping.
     pub fn streaming_iter(&self) -> Result<BytesToEntriesIter<impl io::BufRead>, input::Error> {
         let reader = io::BufReader::with_capacity(4096 * 8, fs::File::open(&self.path)?);
         BytesToEntriesIter::new_from_header(reader, input::Mode::Verify, input::EntryDataMode::KeepAndCrc32)

git-pack/src/data/input/types.rs

@@ -1,7 +1,7 @@
 use std::io;
 
-/// Returned by [`BytesToEntriesIter::new_from_header()`][pack::data::BytesToEntriesIter::new_from_header()] and as part
-/// of `Item` of [`BytesToEntriesIter`][pack::data::BytesToEntriesIter].
+/// Returned by [`BytesToEntriesIter::new_from_header()`][crate::data::BytesToEntriesIter::new_from_header()] and as part
+/// of `Item` of [`BytesToEntriesIter`][crate::data::BytesToEntriesIter].
 #[derive(thiserror::Error, Debug)]
 #[allow(missing_docs)]
 pub enum Error {

git-pack/src/find.rs

@@ -13,7 +13,7 @@ pub trait Find {
     type Error: std::error::Error + 'static;
 
     /// Find an object matching `id` in the database while placing its raw, undecoded data into `buffer`.
-    /// A `pack_cache` can be used to speed up subsequent lookups, set it to [`pack::cache::Never`] if the
+    /// A `pack_cache` can be used to speed up subsequent lookups, set it to [`crate::cache::Never`] if the
     /// workload isn't suitable for caching.
     ///
     /// Returns `Some` object if it was present in the database, or the error that occurred during lookup or object

git-pack/src/index/traverse/types.rs

@@ -1,6 +1,6 @@
 use std::collections::BTreeMap;
 
-/// The outcome of the [`traverse()`][pack::index::File::traverse()] method
+/// The outcome of the [`traverse()`][crate::index::File::traverse()] method
 #[derive(Debug, PartialEq, Eq, Hash, Ord, PartialOrd, Clone)]
 #[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
 pub struct Outcome {
@@ -111,7 +111,7 @@ impl Default for Algorithm {
     }
 }
 
-/// Traversal options for [`traverse()`][pack::index::File::traverse()]
+/// Traversal options for [`traverse()`][crate::index::File::traverse()]
 #[derive(Debug, PartialEq, Eq, Hash, Ord, PartialOrd, Clone)]
 #[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
 pub struct Options {