Skip to content

Commit

Permalink
Update doc for SessionBuilder::control_directory
Browse files Browse the repository at this point in the history
Signed-off-by: Jiahao XU <[email protected]>
  • Loading branch information
NobodyXu committed Jul 28, 2023
1 parent 3319a81 commit 82c80e9
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit 82c80e9

Please sign in to comment.