From 583cdec3d8f8392c5c291511345eb555686805f5 Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Sun, 3 Sep 2023 11:02:19 +0300 Subject: docs(tvix/store): address cargo doc warnings Fix some broken link references. Change-Id: I69c9b2b62af35bb777e4df1a01ba3181a368be47 Reviewed-on: https://cl.tvl.fyi/c/depot/+/9214 Reviewed-by: tazjin Autosubmit: flokli Tested-by: BuildkiteCI --- tvix/store/src/blobservice/from_addr.rs | 2 +- tvix/store/src/blobservice/mod.rs | 2 +- tvix/store/src/directoryservice/mod.rs | 6 +++--- tvix/store/src/fuse/mod.rs | 6 +++--- tvix/store/src/import.rs | 7 ++++--- 5 files changed, 12 insertions(+), 11 deletions(-) (limited to 'tvix/store') 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, 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> can be used as a BlobReader. +/// A [`io::Cursor>`] can be used as a BlobReader. impl BlobReader for io::Cursor> {} 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 + Debug>( blob_service: Arc, -- cgit 1.4.1