From 60d267a548705954ac5cbfafa63f6a3b77590e17 Mon Sep 17 00:00:00 2001
From: Brooks <brooks@solana.com>
Date: Fri, 10 Nov 2023 16:10:51 -0500
Subject: [PATCH] Adds documentation to verify_and_unarchive_snapshots()
 (#34020)

---
 runtime/src/snapshot_utils.rs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/runtime/src/snapshot_utils.rs b/runtime/src/snapshot_utils.rs
index 0cf1aab09..38dd13d78 100644
--- a/runtime/src/snapshot_utils.rs
+++ b/runtime/src/snapshot_utils.rs
@@ -1230,6 +1230,7 @@ pub struct BankFromDirTimings {
 // From testing, 4 seems to be a sweet spot for ranges of 60M-360M accounts and 16-64 cores. This may need to be tuned later.
 const PARALLEL_UNTAR_READERS_DEFAULT: usize = 4;
 
+/// Unarchives the given full and incremental snapshot archives, as long as they are compatible.
 pub fn verify_and_unarchive_snapshots(
     bank_snapshots_dir: impl AsRef<Path>,
     full_snapshot_archive_info: &FullSnapshotArchiveInfo,