This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 54ffc88ae docs(services/sftp): update comments about windows support
and password login support (#2967)
54ffc88ae is described below
commit 54ffc88aea5f546873735e3fe7fb9c4baa1c6ace
Author: Mingzhuo Yin <[email protected]>
AuthorDate: Tue Aug 29 14:12:23 2023 +0800
docs(services/sftp): update comments about windows support and password
login support (#2967)
* docs(services/sftp): update comments about windows support and password
login support
Signed-off-by: silver-ymz <[email protected]>
* update issue link
Signed-off-by: silver-ymz <[email protected]>
---------
Signed-off-by: silver-ymz <[email protected]>
---
core/src/services/sftp/backend.rs | 3 +++
core/src/services/sftp/docs.md | 3 +++
2 files changed, 6 insertions(+)
diff --git a/core/src/services/sftp/backend.rs
b/core/src/services/sftp/backend.rs
index 609496012..c27e0f1e4 100644
--- a/core/src/services/sftp/backend.rs
+++ b/core/src/services/sftp/backend.rs
@@ -40,6 +40,9 @@ use crate::*;
/// SFTP services support. (only works on unix)
///
+/// If you are interested in working on windows, please refer to
[this](https://github.com/apache/incubator-opendal/issues/2963) issue.
+/// Welcome to leave your comments or make contributions.
+///
/// Warning: Maximum number of file holdings is depending on the remote system
configuration.
///
/// For example, the default value is 255 in macOS, and 1024 in linux. If you
want to open
diff --git a/core/src/services/sftp/docs.md b/core/src/services/sftp/docs.md
index e9c994f21..997cd8603 100644
--- a/core/src/services/sftp/docs.md
+++ b/core/src/services/sftp/docs.md
@@ -26,6 +26,9 @@ This service can be used to:
It doesn't support password login, you can use public key instead.
+If you are interested in password login, please refer to
[this](https://github.com/apache/incubator-opendal/issues/2966) issue.
+Welcome to leave your comments or make contributions.
+
You can refer to [`SftpBuilder`]'s docs for more information
## Example
