summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/__init__.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/__init__.xml')
-rw-r--r--src/engine/SCons/Tool/__init__.xml26
1 files changed, 25 insertions, 1 deletions
diff --git a/src/engine/SCons/Tool/__init__.xml b/src/engine/SCons/Tool/__init__.xml
index 721c995..51ae8b0 100644
--- a/src/engine/SCons/Tool/__init__.xml
+++ b/src/engine/SCons/Tool/__init__.xml
@@ -1,5 +1,5 @@
<!--
-Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 The SCons Foundation
+Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
@@ -146,6 +146,19 @@ On some platforms, there is a distinction between a shared library
and a loadable module (explicitly loaded by user action).
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.
+
+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, libbar.so.2, and libbar.so.2.3; on a Darwin (OSX) system
+the library would be libbar.2.3.1.dylib and the link would be
+libbar.dylib.
+
On Windows systems, specifying
<literal>register=1</literal>
will cause the <filename>.dll</filename> to be
@@ -383,3 +396,14 @@ TODO
TODO
</summary>
</cvar>
+
+<cvar name="SHLIBVERSION">
+<summary>
+When this 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.
+</summary>
+</cvar>