Skip to content

Commit cf8fc39

Browse files
committed
Add a warning about SFTP compatibility with Windows
1 parent 4a4f2e4 commit cf8fc39

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/src/sftp.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ API](https://api.libssh.org/stable/group__libssh__sftp.html) is wrapped and
99
available in LibSSH.jl. See the [SFTP example](examples.md#SFTP) for an example
1010
of basic usage.
1111

12+
!!! warning
13+
When it comes to handling paths, the library currently assumes that the
14+
server is running on a *NIX system. Some functions will not work when
15+
connecting to a Windows server.
16+
1217
Unlike the rest of the API, the SFTP C functions are blocking and only work with
1318
blocking [`Session`](@ref)'s. This means that the library has to lock the
1419
session while calling them and no other operations (blocking or unblocking) can

0 commit comments

Comments
 (0)