about summary refs log tree commit diff
path: root/tvix/store
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2023-09-03T08·02+0300
committerflokli <flokli@flokli.de>2023-09-03T10·01+0000
commit583cdec3d8f8392c5c291511345eb555686805f5 (patch)
tree52179728625f46f5810f9c89643cd97096849046 /tvix/store
parent9bbda4421eaab452fc2bd1b6ce0b862cc3988fd0 (diff)
docs(tvix/store): address cargo doc warnings r/6548
Fix some broken link references.

Change-Id: I69c9b2b62af35bb777e4df1a01ba3181a368be47
Reviewed-on: https://cl.tvl.fyi/c/depot/+/9214
Reviewed-by: tazjin <tazjin@tvl.su>
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Diffstat (limited to 'tvix/store')
-rw-r--r--tvix/store/src/blobservice/from_addr.rs2
-rw-r--r--tvix/store/src/blobservice/mod.rs2
-rw-r--r--tvix/store/src/directoryservice/mod.rs6
-rw-r--r--tvix/store/src/fuse/mod.rs6
-rw-r--r--tvix/store/src/import.rs7
5 files changed, 12 insertions, 11 deletions
diff --git a/tvix/store/src/blobservice/from_addr.rs b/tvix/store/src/blobservice/from_addr.rs
index bef1a45a1c3c..2e0a30697d75 100644
--- a/tvix/store/src/blobservice/from_addr.rs
+++ b/tvix/store/src/blobservice/from_addr.rs
@@ -10,7 +10,7 @@ use super::{BlobService, GRPCBlobService, MemoryBlobService, SledBlobService};
 /// - `sled://` ([SledBlobService])
 /// - `grpc+*://` ([GRPCBlobService])
 ///
-/// See their [from_url] methods for more details about their syntax.
+/// See their `from_url` methods for more details about their syntax.
 pub fn from_addr(uri: &str) -> Result<Arc<dyn BlobService>, crate::Error> {
     let url = Url::parse(uri)
         .map_err(|e| crate::Error::StorageError(format!("unable to parse url: {}", e)))?;
diff --git a/tvix/store/src/blobservice/mod.rs b/tvix/store/src/blobservice/mod.rs
index 027b34eb4c6f..33cfb113edd3 100644
--- a/tvix/store/src/blobservice/mod.rs
+++ b/tvix/store/src/blobservice/mod.rs
@@ -51,5 +51,5 @@ pub trait BlobWriter: io::Write + Send + Sync + 'static {
 /// A [io::Read] that also allows seeking.
 pub trait BlobReader: io::Read + io::Seek + Send + 'static {}
 
-/// A Cursor<Vec<u8>> can be used as a BlobReader.
+/// A [`io::Cursor<Vec<u8>>`] can be used as a BlobReader.
 impl BlobReader for io::Cursor<Vec<u8>> {}
diff --git a/tvix/store/src/directoryservice/mod.rs b/tvix/store/src/directoryservice/mod.rs
index c99848c551fd..36e5b10d307d 100644
--- a/tvix/store/src/directoryservice/mod.rs
+++ b/tvix/store/src/directoryservice/mod.rs
@@ -46,9 +46,9 @@ pub trait DirectoryService: Send + Sync {
 
 /// Provides a handle to put a closure of connected [proto::Directory] elements.
 ///
-/// The consumer can periodically call [put], starting from the leaves. Once
-/// the root is reached, [close] can be called to retrieve the root digest (or
-/// an error).
+/// The consumer can periodically call [DirectoryPutter::put], starting from the
+/// leaves. Once the root is reached, [DirectoryPutter::close] can be called to
+/// retrieve the root digest (or an error).
 pub trait DirectoryPutter {
     /// Put a individual [proto::Directory] into the store.
     /// Error semantics and behaviour is up to the specific implementation of
diff --git a/tvix/store/src/fuse/mod.rs b/tvix/store/src/fuse/mod.rs
index 077c6ce048bf..8b44f7db550e 100644
--- a/tvix/store/src/fuse/mod.rs
+++ b/tvix/store/src/fuse/mod.rs
@@ -41,12 +41,12 @@ use self::inode_tracker::InodeTracker;
 /// This means, we need to have a stable mapping of inode numbers to the
 /// corresponding store nodes.
 ///
-/// We internally delegate all inode allocation and state keeping to a
-/// [InodeTracker], and store the currently "explored" store paths together with
+/// We internally delegate all inode allocation and state keeping to the
+/// inode tracker, and store the currently "explored" store paths together with
 /// root inode of the root.
 ///
 /// There's some places where inodes are allocated / data inserted into
-/// [self.inode_tracker], if not allocated before already:
+/// the inode tracker, if not allocated before already:
 ///  - Processing a `lookup` request, either in the mount root, or somewhere
 ///    deeper
 ///  - Processing a `readdir` request
diff --git a/tvix/store/src/import.rs b/tvix/store/src/import.rs
index ec45d9013edc..cb645a6e2e3c 100644
--- a/tvix/store/src/import.rs
+++ b/tvix/store/src/import.rs
@@ -130,9 +130,10 @@ fn process_entry(
 /// interacting with a [BlobService] and [DirectoryService].
 /// It returns the root node or an error.
 ///
-/// It's not interacting with a [PathInfoService], it's up to the caller to
-/// possibly register it somewhere (and potentially rename it based on some
-/// naming scheme.
+/// It's not interacting with a
+/// [PathInfoService](crate::pathinfoservice::PathInfoService), it's up to the
+/// caller to possibly register it somewhere (and potentially rename it based on
+/// some naming scheme.
 #[instrument(skip(blob_service, directory_service), fields(path=?p))]
 pub fn ingest_path<P: AsRef<Path> + Debug>(
     blob_service: Arc<dyn BlobService>,