summaryrefslogtreecommitdiffstats
path: root/doc/generated
diff options
context:
space:
mode:
authorDirk Baechle <dl9obn@darc.de>2013-10-06 15:04:19 (GMT)
committerDirk Baechle <dl9obn@darc.de>2013-10-06 15:04:19 (GMT)
commite2d8d87c5911067374d0b3b5be562c4ce2dddcce (patch)
tree2ee5b8a387b880e61a23a7abda1a152fead7af00 /doc/generated
parent43f296c7c2a350de0c59a442e566c165420803e3 (diff)
downloadSCons-e2d8d87c5911067374d0b3b5be562c4ce2dddcce.zip
SCons-e2d8d87c5911067374d0b3b5be562c4ce2dddcce.tar.gz
SCons-e2d8d87c5911067374d0b3b5be562c4ce2dddcce.tar.bz2
- left-aligned all code examples in documentation
- accordingly updated the generated files, containing example output
Diffstat (limited to 'doc/generated')
-rw-r--r--doc/generated/builders.gen13
-rw-r--r--doc/generated/examples/commandline_Variables_custom_py_1_custom.py2
-rw-r--r--doc/generated/examples/depends_ex1_5.xml2
-rw-r--r--doc/generated/examples/depends_include_SConstruct2
-rw-r--r--doc/generated/examples/depends_include_hello.h2
-rw-r--r--doc/generated/examples/hierarchy_Return_foo_SConscript6
-rw-r--r--doc/generated/examples/hierarchy_ex1_prog1_SConscript4
-rw-r--r--doc/generated/examples/hierarchy_ex1_prog2_SConscript4
-rw-r--r--doc/generated/examples/separate_builddir_sconscript_SConstruct4
-rw-r--r--doc/generated/variables.gen20
-rw-r--r--doc/generated/variables.mod2
11 files changed, 47 insertions, 14 deletions
diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen
index eec4711..3fdafb6 100644
--- a/doc/generated/builders.gen
+++ b/doc/generated/builders.gen
@@ -1841,6 +1841,17 @@ listed in the targets.
</para>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
+On Cygwin systems, the
+<function xmlns="http://www.scons.org/dbxsd/v1.0">SharedLibrary</function>
+builder method will always build an import
+(<filename>.dll.a</filename>) library
+in addition to the shared (<filename>.dll</filename>) library,
+adding a <filename>.dll.a</filename> library with the same basename
+if there is not already a <filename>.dll.a</filename> file explicitly
+listed in the targets.
+</para>
+
+<para xmlns="http://www.scons.org/dbxsd/v1.0">
Any object files listed in the
<literal>source</literal>
must have been built for a shared library
@@ -1870,7 +1881,7 @@ alpha, beta, or release candidate patch levels.
<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
-libbar.so, libbar.so.2, and libbar.so.2.3; on a Darwin (OSX) system
+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>
diff --git a/doc/generated/examples/commandline_Variables_custom_py_1_custom.py b/doc/generated/examples/commandline_Variables_custom_py_1_custom.py
index f2acb0d..ff314fa 100644
--- a/doc/generated/examples/commandline_Variables_custom_py_1_custom.py
+++ b/doc/generated/examples/commandline_Variables_custom_py_1_custom.py
@@ -1,3 +1,3 @@
- RELEASE = 1
+RELEASE = 1
diff --git a/doc/generated/examples/depends_ex1_5.xml b/doc/generated/examples/depends_ex1_5.xml
index abbe64e..136def6 100644
--- a/doc/generated/examples/depends_ex1_5.xml
+++ b/doc/generated/examples/depends_ex1_5.xml
@@ -5,5 +5,5 @@ cc -o hello hello.o
% [CHANGE A COMMENT IN hello.c]
% <userinput>scons -Q hello</userinput>
cc -o hello.o -c hello.c
-scons: `hello' is up to date.
+cc -o hello hello.o
</screen>
diff --git a/doc/generated/examples/depends_include_SConstruct b/doc/generated/examples/depends_include_SConstruct
index 5f6d7f5..2da2ecf 100644
--- a/doc/generated/examples/depends_include_SConstruct
+++ b/doc/generated/examples/depends_include_SConstruct
@@ -1,3 +1,3 @@
- Program('hello.c', CPPPATH = '.')
+Program('hello.c', CPPPATH = '.')
diff --git a/doc/generated/examples/depends_include_hello.h b/doc/generated/examples/depends_include_hello.h
index c9046b3..d6032ce 100644
--- a/doc/generated/examples/depends_include_hello.h
+++ b/doc/generated/examples/depends_include_hello.h
@@ -1,3 +1,3 @@
- #define string "world"
+#define string "world"
diff --git a/doc/generated/examples/hierarchy_Return_foo_SConscript b/doc/generated/examples/hierarchy_Return_foo_SConscript
index 5d74264..4f45c0f 100644
--- a/doc/generated/examples/hierarchy_Return_foo_SConscript
+++ b/doc/generated/examples/hierarchy_Return_foo_SConscript
@@ -1,5 +1,5 @@
- Import('env')
- obj = env.Object('foo.c')
- Return('obj')
+Import('env')
+obj = env.Object('foo.c')
+Return('obj')
diff --git a/doc/generated/examples/hierarchy_ex1_prog1_SConscript b/doc/generated/examples/hierarchy_ex1_prog1_SConscript
index 425f1b8..caf2636 100644
--- a/doc/generated/examples/hierarchy_ex1_prog1_SConscript
+++ b/doc/generated/examples/hierarchy_ex1_prog1_SConscript
@@ -1,4 +1,4 @@
- env = Environment()
- env.Program('prog1', ['main.c', 'foo1.c', 'foo2.c'])
+env = Environment()
+env.Program('prog1', ['main.c', 'foo1.c', 'foo2.c'])
diff --git a/doc/generated/examples/hierarchy_ex1_prog2_SConscript b/doc/generated/examples/hierarchy_ex1_prog2_SConscript
index fb529b4..88b05a3 100644
--- a/doc/generated/examples/hierarchy_ex1_prog2_SConscript
+++ b/doc/generated/examples/hierarchy_ex1_prog2_SConscript
@@ -1,4 +1,4 @@
- env = Environment()
- env.Program('prog2', ['main.c', 'bar1.c', 'bar2.c'])
+env = Environment()
+env.Program('prog2', ['main.c', 'bar1.c', 'bar2.c'])
diff --git a/doc/generated/examples/separate_builddir_sconscript_SConstruct b/doc/generated/examples/separate_builddir_sconscript_SConstruct
index c3da725..d53d1c6 100644
--- a/doc/generated/examples/separate_builddir_sconscript_SConstruct
+++ b/doc/generated/examples/separate_builddir_sconscript_SConstruct
@@ -1,4 +1,4 @@
- VariantDir('build', 'src')
- SConscript('build/SConscript')
+VariantDir('build', 'src')
+SConscript('build/SConscript')
diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen
index 1828112..b213916 100644
--- a/doc/generated/variables.gen
+++ b/doc/generated/variables.gen
@@ -7352,6 +7352,26 @@ General options passed to the zip utility.
</para>
</listitem>
</varlistentry>
+ <varlistentry id="cv-ZIPROOT">
+ <term>ZIPROOT</term>
+ <listitem>
+An optional zip root directory (default empty). The filenames stored
+in the zip file will be relative to this directory, if given.
+Otherwise the filenames are relative to the current directory of the
+command.
+For instance:
+<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
+env = Environment()
+env.Zip('foo.zip', 'subdir1/subdir2/file1', ZIPROOT='subdir1')
+</example_commands>
+<para xmlns="http://www.scons.org/dbxsd/v1.0">
+will produce a zip file <literal>foo.zip</literal>
+containing a file with the name
+<literal>subdir2/file1</literal> rather than
+<literal>subdir1/subdir2/file1</literal>.
+</para>
+</listitem>
+ </varlistentry>
<varlistentry id="cv-ZIPSUFFIX">
<term>ZIPSUFFIX</term>
<listitem>
diff --git a/doc/generated/variables.mod b/doc/generated/variables.mod
index 7247f55..8a898ec 100644
--- a/doc/generated/variables.mod
+++ b/doc/generated/variables.mod
@@ -576,6 +576,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY cv-ZIPCOMPRESSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$ZIPCOMPRESSION</envar>">
<!ENTITY cv-ZIPCOMSTR "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$ZIPCOMSTR</envar>">
<!ENTITY cv-ZIPFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$ZIPFLAGS</envar>">
+<!ENTITY cv-ZIPROOT "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$ZIPROOT</envar>">
<!ENTITY cv-ZIPSUFFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$ZIPSUFFIX</envar>">
<!--
@@ -1156,6 +1157,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY cv-link-ZIPCOMPRESSION "<link linkend='cv-ZIPCOMPRESSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$ZIPCOMPRESSION</envar></link>">
<!ENTITY cv-link-ZIPCOMSTR "<link linkend='cv-ZIPCOMSTR' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$ZIPCOMSTR</envar></link>">
<!ENTITY cv-link-ZIPFLAGS "<link linkend='cv-ZIPFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$ZIPFLAGS</envar></link>">
+<!ENTITY cv-link-ZIPROOT "<link linkend='cv-ZIPROOT' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$ZIPROOT</envar></link>">
<!ENTITY cv-link-ZIPSUFFIX "<link linkend='cv-ZIPSUFFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$ZIPSUFFIX</envar></link>">
<!--