diff options
author | Jake Petroules <jake.petroules@theqtcompany.com> | 2015-08-13 16:47:43 -0700 |
---|---|---|
committer | Jake Petroules <jake.petroules@theqtcompany.com> | 2016-03-17 05:05:05 +0000 |
commit | 868f33fc325855d7539d2771c7683f2792e7edd2 (patch) | |
tree | f755a6d1db73fc2e35c81ad94dd43280fc9cb90b /doc | |
parent | 6f17b962144390ed9b13d74cdbdc6727e740a821 (diff) |
Support soname prefixes on non-Apple Unix-like platforms.
Change-Id: I48fb27137e9eafea021eff3cf0cf9c4087c0be89
Reviewed-by: Jake Petroules <jake.petroules@theqtcompany.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference/modules/cpp-module.qdoc | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/reference/modules/cpp-module.qdoc b/doc/reference/modules/cpp-module.qdoc index df11e40ed..49d681260 100644 --- a/doc/reference/modules/cpp-module.qdoc +++ b/doc/reference/modules/cpp-module.qdoc @@ -398,6 +398,7 @@ \li The prefix for the internal install name (LC_ID_DYLIB) of a dynamic library on Darwin (OS X and iOS). Typically this should be set to \c{"@rpath"} on modern platforms that support it, which includes OS X 10.5 and above, and all versions of iOS. + \b Deprecated: use \c{cpp.sonamePrefix} instead. \row \li automaticReferenceCounting \li \c{bool} @@ -529,6 +530,36 @@ \li \c{undefined} \li List of rpaths that are passed to the linker. \row + \li sonamePrefix + \li \c{string} + \li 1.5 + \li \c{undefined} + \li If defined, the value of this variable is used as a path to be prepended to + the built shared library's \c SONAME identifier. The \c SONAME + (\c LC_ID_DYLIB on Apple platforms, \c DT_SONAME on other Unix-like platforms) is the + identifier that the dynamic linker will later use to reference the library. + In general, this reference may be a library name or full library path. + + On Apple platforms, the path may contain the following placeholders: + + \list + \li \b @rpath - + Expands to paths defined by LC_RPATH Mach-O commands in + the current process executable or the referring libraries. + \li \b @executable_path - + Expands to the current process executable location. + \li \b @loader_path - + Expands to the referring executable or library location. + \endlist + + In most cases, using \c @rpath is sufficient and recommended. + However, the prefix may be also specified using different placeholders, or + an absolute path. + + For more information, see the + \l{https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/dyld.1.html}{dyld documentation} + on dynamic library install names. + \row \li useRPaths \li \c{bool} \li 1.3 |