From 82c80e90059d65fa1e62df359d2c73192fe9bac7 Mon Sep 17 00:00:00 2001
From: Jiahao XU <Jiahao_XU@outlook.com>
Date: Fri, 28 Jul 2023 17:52:30 +1000
Subject: [PATCH] Update doc for `SessionBuilder::control_directory`

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
---
 src/builder.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/builder.rs b/src/builder.rs
index 570544d3b..85a9131cd 100644
--- a/src/builder.rs
+++ b/src/builder.rs
@@ -125,7 +125,10 @@ impl SessionBuilder {
     /// Set the directory in which the temporary directory containing the control socket will
     /// be created.
     ///
-    /// If not set, `./` will be used (the current directory).
+    /// If not set, openssh will try to use [`dirs::state_dir`] and fallback to
+    /// `./` will be used (the current directory) if it failed.
+    ///
+    /// [`dirs::state_dir`]: https://docs.rs/dirs/latest/dirs/fn.state_dir.html
     #[cfg(not(windows))]
     #[cfg_attr(docsrs, doc(cfg(not(windows))))]
     pub fn control_directory(&mut self, p: impl AsRef<Path>) -> &mut Self {