aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAris Adamantiadis <aris@0xbadc0de.be>2011-05-27 13:26:15 +0200
committerAris Adamantiadis <aris@0xbadc0de.be>2011-05-27 13:26:15 +0200
commitc84380bad55dba3cb06486dc7f19c0ea6705a060 (patch)
tree27971d129bf4d1e9827c078869b3248ec04aa54f
parent17454caf641676aaabb0ff2c4c2d9d1106413d47 (diff)
downloadlibssh-c84380bad55dba3cb06486dc7f19c0ea6705a060.tar.gz
libssh-c84380bad55dba3cb06486dc7f19c0ea6705a060.tar.xz
libssh-c84380bad55dba3cb06486dc7f19c0ea6705a060.zip
Fix documentation bug about threading
-rw-r--r--doc/threading.dox14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/threading.dox b/doc/threading.dox
index a18a3fb6..4860f54b 100644
--- a/doc/threading.dox
+++ b/doc/threading.dox
@@ -6,16 +6,16 @@ libssh may be used in multithreaded applications, but under several conditions :
- Threading must be initialized during the initialization of libssh. This
initialization must be done outside of any threading context.
- If pthreads is being used by your application (or your framework's backend),
- you must link with libssh_threads_pthread dynamic library and initialize
+ you must link with libssh_threads dynamic library and initialize
threading with the ssh_threads_pthreads threading object.
- If an other threading library is being used by your application, you must
implement all the methods of the ssh_threads_callbacks_struct structure
and initialize libssh with it.
- At all times, you may use different sessions inside threads, make parallel
- connections, read/write on different sessions and so on. You can use a
- single session in several channels at the same time. This will lead to
- internal state corruption. This limitation is being worked out and will
- maybe disappear later.
+ connections, read/write on different sessions and so on. You *cannot* use a
+ single session (or channels for a single session) in several threads at the same
+ time. This will most likely lead to internal state corruption. This limitation is
+ being worked out and will maybe disappear later.
@subsection threads_init Initialization of threads
@@ -44,10 +44,10 @@ ssh_threads_set_callbacks(ssh_threads_pthread);
ssh_init();
@endcode
-However, you must be sure to link with the library ssh_threads_pthread. If
+However, you must be sure to link with the library ssh_threads. If
you're using gcc, you must use the commandline
@code
-gcc -o output input.c -lssh -lssh_threads_pthread
+gcc -o output input.c -lssh -lssh_threads
@endcode