summaryrefslogtreecommitdiffstats
path: root/doc/generated
diff options
context:
space:
mode:
authorDirk Baechle <dl9obn@darc.de>2015-04-06 16:11:15 (GMT)
committerDirk Baechle <dl9obn@darc.de>2015-04-06 16:11:15 (GMT)
commit08eae186d3237d214b5db70af9e54360002701e4 (patch)
treeadb5ebc87bea4941cf4cf815f3b870a65885f9ae /doc/generated
parent0aae461a4be40d812ba8ec7c1026a7188101e4a4 (diff)
parent46536adb150648780c0f79cc26390376a386894f (diff)
downloadSCons-08eae186d3237d214b5db70af9e54360002701e4.zip
SCons-08eae186d3237d214b5db70af9e54360002701e4.tar.gz
SCons-08eae186d3237d214b5db70af9e54360002701e4.tar.bz2
Merged in bdbaddog/scons (pull request #230), extending docs for InstallVersionedLib and SharedLibrary
Diffstat (limited to 'doc/generated')
-rw-r--r--doc/generated/builders.gen24
1 files changed, 20 insertions, 4 deletions
diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen
index 259fe79..02dc04b 100644
--- a/doc/generated/builders.gen
+++ b/doc/generated/builders.gen
@@ -486,6 +486,14 @@ and
source
arguments list different numbers of files or directories.
</para>
+
+<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
+env.InstallAs(target = '/usr/local/bin/foo',
+ source = 'foo_debug')
+env.InstallAs(target = ['../lib/libfoo.a', '../lib/libbar.a'],
+ source = ['libFOO.a', 'libBAR.a'])
+</example_commands>
+
</listitem>
</varlistentry>
<varlistentry id="b-InstallVersionedLib">
@@ -500,14 +508,17 @@ arguments list different numbers of files or directories.
Installs a versioned shared library. The <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link>
construction variable should be defined in the environment
to confirm the version number in the library name.
+If <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> is not defined a warning will be issued
+and the name of the library will be parsed to derive the version.
The symlinks appropriate to the architecture will be generated.
</para>
<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
-env.InstallAs(target = '/usr/local/bin/foo',
- source = 'foo_debug')
-env.InstallAs(target = ['../lib/libfoo.a', '../lib/libbar.a'],
- source = ['libFOO.a', 'libBAR.a'])
+env.InstallVersionedLib(target = '/usr/local/bin/foo',
+ source = 'libxyz.1.5.2.so')
+env.InstallVersionedLib(target = '/usr/local/bin/foo',
+ source = 'libxyz.1.5.2.so',
+ SHLIBVERSION='1.5.2')
</example_commands>
</listitem>
</varlistentry>
@@ -1989,6 +2000,11 @@ and Y are numbers, and Z is a number but can also contain letters to designate
alpha, beta, or release candidate patch levels.
</para>
+<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
+env.SharedLibrary(target = 'bar', source = ['bar.c', 'foo.o'], SHLIBVERSION='1.5.2')
+</example_commands>
+
+
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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