diff options
| author | Mitch Curtis <mitch.curtis@qt.io> | 2019-11-22 15:39:45 +0100 |
|---|---|---|
| committer | Mitch Curtis <mitch.curtis@qt.io> | 2019-11-28 11:12:07 +0000 |
| commit | 3ed09bb9f6dfac876c6d9f4917fcb32c3ea08635 (patch) | |
| tree | 091c7ac0a018b0c7b598dd2cb579bb67e56d0747 /doc | |
| parent | 0194da9692c726b9b599f852e579fbfe5d4197f5 (diff) | |
Improve libraryPaths and dynamicLibraries documentation
Task-number: QBS-1516
Change-Id: I7403ed5ef1873e97da6848c7eaa0ddd21812c44c
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/reference/modules/cpp-module.qdoc | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/reference/modules/cpp-module.qdoc b/doc/reference/modules/cpp-module.qdoc index 64a7c071f..19575a0f8 100644 --- a/doc/reference/modules/cpp-module.qdoc +++ b/doc/reference/modules/cpp-module.qdoc @@ -457,10 +457,16 @@ A list of library search paths. + The paths will be passed to the linker in the appropriate way. For + example, the \c {-L} argument will be used when using \c {ld}-like + linkers. + Relative paths are considered to be relative to the \c .qbs product file they are used in. \nodefaultvalue + + \sa dynamicLibraries, {How do I create a module for a third-party library?} */ /*! @@ -471,7 +477,21 @@ If the library is part of your project, consider using a \l{Depends} item instead. + Each library can be specified in one of two ways: + + \list + \li An absolute file path (for example, \c "/foo/bar.lib"), in which case + it is passed directly to the linker, ignoring \l libraryPaths. + \li A library basename (for example, \c "bar"), in which case + the directory that contains the library must be provided via + \l libraryPaths. + \endlist + + Relative paths (\c "foo/bar.lib") are not allowed. + \nodefaultvalue + + \sa libraryPaths, {How do I create a module for a third-party library?} */ /*! |