From 9156b8c06837af58c25ec40b5d64906a6531dc5e Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 1 Aug 2013 14:07:36 +0200 Subject: [PATCH] doc: Better explain LIBSSH_STATIC. --- doc/linking.dox | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/doc/linking.dox b/doc/linking.dox index 16dfab98..8cbc415c 100644 --- a/doc/linking.dox +++ b/doc/linking.dox @@ -17,8 +17,14 @@ On UNIX systems linking against the static version of the library is the same as linking against the shared library. Both have the same name. Some build system require to use the full path to the static library. -On Windows you need to define LIBSSH_STATIC in the compiler command -line. This is required cause the dynamic library needs to specify the -dllimport attribute. +To be able to compile the application you're developing you need to either pass +LIBSSH_STATIC as a define in the compiler command line or define it before you +include libssh.h. This is required cause the dynamic library needs to specify +the dllimport attribute. + +@code +#define LIBSSH_STATIC 1 +#include +@endcode */