From 43af9484c0f4d0c82f6a8d6ba5b9cc6c9288d20e Mon Sep 17 00:00:00 2001
From: Joonas Koivunen <joonas@neon.tech>
Date: Mon, 22 Jul 2024 19:53:01 +0000
Subject: [PATCH] doc: schedule_reparenting_and_wait

---
 pageserver/src/tenant/remote_timeline_client.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/pageserver/src/tenant/remote_timeline_client.rs b/pageserver/src/tenant/remote_timeline_client.rs
index 71e332de9b..0e7eae5908 100644
--- a/pageserver/src/tenant/remote_timeline_client.rs
+++ b/pageserver/src/tenant/remote_timeline_client.rs
@@ -683,6 +683,9 @@ impl RemoteTimelineClient {
         Ok(())
     }
 
+    /// Reparent this timeline to a new parent.
+    ///
+    /// A retryable step of timeline ancestor detach.
     pub(crate) async fn schedule_reparenting_and_wait(
         self: &Arc<Self>,
         new_parent: &TimelineId,