summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGary Oberbrunner <garyo@oberbrunner.com>2012-12-20 23:57:33 -0500
committerGary Oberbrunner <garyo@oberbrunner.com>2012-12-20 23:57:33 -0500
commitb646c1c4a6d4825a03798ac610c3cb6d37bdbe02 (patch)
tree797aa1273503715a04ed365858a9228775beea4b
parentb91167a75ea49620ea587482df0efd30d9a9cf16 (diff)
downloadscons-git-b646c1c4a6d4825a03798ac610c3cb6d37bdbe02.tar.gz
Fixed up docs for InstallVersionedLib and SHLIBVERSION.
-rw-r--r--src/engine/SCons/Tool/__init__.xml23
-rw-r--r--src/engine/SCons/Tool/install.xml6
2 files changed, 21 insertions, 8 deletions
diff --git a/src/engine/SCons/Tool/__init__.xml b/src/engine/SCons/Tool/__init__.xml
index d491fa5da..532c8503a 100644
--- a/src/engine/SCons/Tool/__init__.xml
+++ b/src/engine/SCons/Tool/__init__.xml
@@ -148,15 +148,15 @@ 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
+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
+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
@@ -396,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>
diff --git a/src/engine/SCons/Tool/install.xml b/src/engine/SCons/Tool/install.xml
index d9cb6710d..bec592bc1 100644
--- a/src/engine/SCons/Tool/install.xml
+++ b/src/engine/SCons/Tool/install.xml
@@ -24,7 +24,7 @@ which must be a directory.
The names of the specified source files or directories
remain the same within the destination directory. The
sources may be given as a string or as a node returned by
-a builder.
+a builder.
<example>
env.Install('/usr/local/bin', source = ['foo', 'bar'])
@@ -43,10 +43,12 @@ target
and
source
arguments list different numbers of files or directories.
+</summary>
+</builder>
<builder name="InstallVersionedLib">
<summary>
-Installs a versioned shared library. The &cv-link-SHLIBVERSION;
+Installs a versioned shared library. The &cv-link-SHLIBVERSION;
construction variable should be defined in the environment
to confirm the version number in the library name.
The symlinks appropriate to the architecture will be generated.