Added note about using recursive flag with rmdir

theophilusx · Aug 11, 2020 · 8fd565d · 8fd565d
1 parent 762ddb2
commit 8fd565d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -760,6 +760,8 @@ Remove a directory. If removing a directory and recursive flag is set to `true`,
 -   **path:** string. Path to remote directory
 -   **recursive:** boolean. If true, remove all files and directories in target directory. Defaults to false
 
+**Note**: There has been at least one report that some SFTP servers will allow non-empty directories to be removed even without the recursive flag being set to true. While this is not standard behaviour, it is recommended that users verify the behaviour of rmdir if there are plans to rely on the recursive flag to prevent removal of non-empty directories.
+
 1.  Example Use
 
     ```javascript

diff --git a/README.org b/README.org
@@ -875,6 +875,12 @@ action will fail.
 - recursive :: boolean. If true, remove all files and directories in target
                directory. Defaults to false
 
+*Note*: There has been at least one report that some SFTP servers will allow
+non-empty directories to be removed even without the recursive flag being set to
+true. While this is not standard behaviour, it is recommended that users verify
+the behaviour of rmdir if there are plans to rely on the recursive flag to
+prevent removal of non-empty directories.
+
 **** Example Use
 
 #+begin_src javascript