[mina-sshd] 01/02: Fixed documentation regarding SFTP directory scanners usage

[lg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

lgoldstein pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-sshd.git

commit 3d6292cab635b2d40b9c470d214c0bcb14853813
Author: Lyor Goldstein <lg...@apache.org>
AuthorDate: Thu Nov 26 17:13:26 2020 +0200

    Fixed documentation regarding SFTP directory scanners usage
---
 docs/sftp.md | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/docs/sftp.md b/docs/sftp.md
index 447bd3c..6ab65cf 100644
--- a/docs/sftp.md
+++ b/docs/sftp.md
@@ -130,8 +130,8 @@ it consults the `AbstractSftpSubsystemHelper#resolvePathResolutionFollowLinks` m
 the value of the `sftp-auto-follow-links` configuration property (default=*true*).
 
 **Note:** the property is consulted only for cases where there is no clear indication in the standard how to behave for the
-specific command. E.g., the `lsetstat@openssh.com` specifically specifies that symbolic links should not be followed, so the
-implementation does not consult the aforementioned property.
+specific command. E.g., the `lsetstat@openssh.com` command specifically specifies that symbolic links should not be followed,
+so the implementation does not consult the aforementioned property.
 
 ## Client-side SFTP
 
@@ -459,12 +459,13 @@ classes for supported patterns and matching - include case sensitive vs. insensi
 ```java
 // Using an SftpPathDirectoryScanner
 FileSystem fs = ... obtain an SFTP file system instance ...
-Path rootDir = fs.getPath(...remote path...);
+Path basedir = fs.getPath("/some/remote/path");
 DirectoryScanner ds = new SftpPathDirectoryScanner(basedir, ...pattern...);
 Collection<Path> matches = ds.scan();
 
 // Using an SftpClientDirectoryScanner
 SftpClient client = ... obtain a client instance ...
+Strinng basedir = "/some/remote/path";
 SftpClientDirectoryScanner ds = new SftpClientDirectoryScanner(basedir, ...pattern...);
 Collection<ScanDirEntry> matches = ds.scan(client);