Skip to content

Commit

Permalink
Fix docs, add note about permissions
Browse files Browse the repository at this point in the history
Created using spr 1.3.4
  • Loading branch information
sunshowers committed Oct 6, 2023
1 parent 5e7528c commit 396af26
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions test-utils/src/dev/seed.rs
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ pub async fn ensure_seed_tarball_exists(
);
}

// XXX: we aren't considering cross-user permissions for this file. Might be
// worth setting more restrictive permissions on it.
let base_seed_dir = Utf8PathBuf::from_path_buf(std::env::temp_dir())
.expect("Not a UTF-8 path")
.join("crdb-base");
Expand Down Expand Up @@ -140,11 +142,11 @@ pub async fn ensure_seed_tarball_exists(
Ok((desired_seed_tar, status))
}

/// Creates a [`db::CockroachInstance`] with a populated storage directory
/// inside a tarball.
/// Creates a seed file for a Cockroach database at the output tarball.
///
/// This is intended to optimize subsequent calls to [`test_setup_database`] by
/// reducing the latency of populating the storage directory.
/// This is intended to optimize subsequent calls to
/// [`test_setup_database`](super::test_setup_database) by reducing the latency
/// of populating the storage directory.
pub async fn test_setup_database_seed(
log: &Logger,
output_tar: &Utf8Path,
Expand Down

0 comments on commit 396af26

Please sign in to comment.