about summary refs log tree commit diff
path: root/tvix/castore/src
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2024-04-30T07·08+0300
committerflokli <flokli@flokli.de>2024-04-30T10·06+0000
commitca64881cb3fe4a5e30baf0f0b1f457af44bb143a (patch)
tree0c7d558100495e3efcff00ea5f2ab4c483bda380 /tvix/castore/src
parent06f94a21bd355e13fa4a51817f5d3f128add9928 (diff)
docs(tvix/castore): fix tvix_castore::import sub-mod docstrings r/8044
The one for `fs` was wrong, and ended up being attached to ingest_path,
and the one for `archive` was missing entirely.

Change-Id: I8a4c32fb5293badb1ea0764c278a88e4ca33c018
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11552
Tested-by: BuildkiteCI
Reviewed-by: edef <edef@edef.eu>
Diffstat (limited to 'tvix/castore/src')
-rw-r--r--tvix/castore/src/import/archive.rs2
-rw-r--r--tvix/castore/src/import/fs.rs4
2 files changed, 4 insertions, 2 deletions
diff --git a/tvix/castore/src/import/archive.rs b/tvix/castore/src/import/archive.rs
index adcfb871d5e3..b13716f54f7f 100644
--- a/tvix/castore/src/import/archive.rs
+++ b/tvix/castore/src/import/archive.rs
@@ -1,3 +1,5 @@
+//! Imports from an archive (tarballs)
+
 use std::io::{Cursor, Write};
 use std::sync::Arc;
 use std::{collections::HashMap, path::PathBuf};
diff --git a/tvix/castore/src/import/fs.rs b/tvix/castore/src/import/fs.rs
index 6709d4a127e9..03a52f2ba073 100644
--- a/tvix/castore/src/import/fs.rs
+++ b/tvix/castore/src/import/fs.rs
@@ -1,3 +1,5 @@
+//! Import from a real filesystem.
+
 use futures::stream::BoxStream;
 use futures::StreamExt;
 use std::os::unix::fs::MetadataExt;
@@ -16,8 +18,6 @@ use super::upload_blob_at_path;
 use super::Error;
 use super::IngestionEntry;
 
-///! Imports that deal with a real filesystem.
-
 /// Ingests the contents at a given path into the tvix store, interacting with a [BlobService] and
 /// [DirectoryService]. It returns the root node or an error.
 ///