diff options
author | William Blevins <wblevins001@gmail.com> | 2015-09-23 21:59:56 (GMT) |
---|---|---|
committer | William Blevins <wblevins001@gmail.com> | 2015-09-23 21:59:56 (GMT) |
commit | 9efc846a1dbd96a07f1141497015129543a0274b (patch) | |
tree | 320a4b7486ae6cc0e86905a29507ccbbe4b5aa5a /src | |
parent | 366627b426a8b90e0c1fc0ffaf51f31dbdf76de1 (diff) | |
download | SCons-9efc846a1dbd96a07f1141497015129543a0274b.zip SCons-9efc846a1dbd96a07f1141497015129543a0274b.tar.gz SCons-9efc846a1dbd96a07f1141497015129543a0274b.tar.bz2 |
Updated SHLIBVERSION documentation to reflect PR-247.
Diffstat (limited to 'src')
-rw-r--r-- | src/engine/SCons/Tool/__init__.xml | 28 |
1 files changed, 12 insertions, 16 deletions
diff --git a/src/engine/SCons/Tool/__init__.xml b/src/engine/SCons/Tool/__init__.xml index 7f19bfc..358ff1e 100644 --- a/src/engine/SCons/Tool/__init__.xml +++ b/src/engine/SCons/Tool/__init__.xml @@ -200,22 +200,20 @@ For maximum portability, use the &b-LoadableModule; builder for the latter. When the &cv-link-SHLIBVERSION; construction variable is defined a versioned shared library is created. This modifies the &cv-link-SHLINKFLAGS; as required, adds the version number to the library name, and creates the symlinks that -are needed. &cv-link-SHLIBVERSION; needs to be of the form X.Y.Z, where X -and Y are numbers, and Z is a number but can also contain letters to designate -alpha, beta, or release candidate patch levels. +are needed. </para> <example_commands> env.SharedLibrary(target = 'bar', source = ['bar.c', 'foo.o'], SHLIBVERSION='1.5.2') </example_commands> - <para> -This builder may create multiple links to the library. On a POSIX system, -for the shared library libbar.so.2.3.1, the links created would be -libbar.so and libbar.so.2; on a Darwin (OSX) system -the library would be libbar.2.3.1.dylib and the link would be -libbar.dylib. +On a POSIX system, versions with a single token create exactly one symlink: +libbar.so.6 would have symlinks libbar.so only. +On a POSIX system, versions with two or more +tokens create exactly two symlinks: libbar.so.2.3.1 would have symlinks +libbar.so and libbar.so.2; on a Darwin (OSX) system the library would be +libbar.2.3.1.dylib and the link would be libbar.dylib. </para> <para> @@ -490,10 +488,8 @@ When this construction variable is defined, a versioned loadable module is created by &b-link-LoadableModule; builder. This activates the &cv-link-_LDMODULEVERSIONFLAGS; and thus modifies the &cv-link-LDMODULECOM; as required, adds the version number to the library name, and creates the symlinks -that are needed. &cv-link-LDMODULEVERSION; needs to be of the form X.Y.Z, where -X and Y are numbers, and Z is a number but can also contain letters to -designate alpha, beta, or release candidate patch levels. By default -&cv-link-LDMODULEVERSION; is set to $SHLIBVERSION. +that are needed. &cv-link-LDMODULEVERSION; versions should exist in the same +format as &cv-link-SHLIBVERSION. </para> </summary> </cvar> @@ -521,9 +517,9 @@ When this construction variable is defined, a versioned shared library is created by &b-link-SharedLibrary; builder. This activates the &cv-link-_SHLIBVERSIONFLAGS; and thus modifies the &cv-link-SHLINKCOM; as required, adds the version number to the library name, and creates the symlinks -that are needed. &cv-link-SHLIBVERSION; needs to be of the form X.Y.Z, where X -and Y are numbers, and Z is a number but can also contain letters to designate -alpha, beta, or release candidate patch levels. +that are needed. &cv-link-SHLIBVERSION; versions should exist as alpha-numeric, +decimal-delimited values as defined by the regular expression "\w+[\.\w+]*". +Example &cv-link-SHLIBVERSION; values include '1', '1.2.3', and '1.2.gitaa412c8b'. </para> </summary> </cvar> |