From dc97f95636a8739616001eda86143a90f6b1eee8 Mon Sep 17 00:00:00 2001
From: Bojan Serafimov <bojan.serafimov7@gmail.com>
Date: Fri, 17 Jun 2022 15:39:18 -0400
Subject: [PATCH] Add docstring

---
 control_plane/src/storage.rs | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/control_plane/src/storage.rs b/control_plane/src/storage.rs
index 82256f3f8a..f1eaa99904 100644
--- a/control_plane/src/storage.rs
+++ b/control_plane/src/storage.rs
@@ -529,6 +529,15 @@ impl PageServerNode {
         Ok(timeline_info_response)
     }
 
+    /// Import a basebackup prepared using either:
+    /// a) `pg_basebackup -F tar`, or
+    /// b) The `fullbackup` pageserver endpoint
+    ///
+    /// # Arguments
+    /// * `tenant_id` - tenant to import into. Created if not exists
+    /// * `timeline_id` - id to assign to imported timeline
+    /// * `base` - (start lsn of basebackup, path to `base.tar` file)
+    /// * `pg_wal` - if there's any wal to import: (end lsn, path to `pg_wal.tar`)
     pub fn timeline_import(
         &self,
         tenant_id: ZTenantId,