summaryrefslogtreecommitdiff
path: root/scons.1
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2017-12-16 09:37:25 +0100
committerJörg Frings-Fürst <debian@jff-webhosting.net>2017-12-16 09:37:25 +0100
commit64bc937d72e11ca55df5475f88f5b4419bd0d287 (patch)
treedfb4c64908867f75bd2fff2c601b3354d2eb4d77 /scons.1
parent4d4007854125818bf3d71ef1a94c9fad3f6c8e0e (diff)
parent379b7995fe7e7ecd5583d73d8c4e352cd487578c (diff)
Merge branch 'release/3.0.1-1'3.0.1-1
Diffstat (limited to 'scons.1')
-rw-r--r--scons.1123
1 files changed, 99 insertions, 24 deletions
diff --git a/scons.1 b/scons.1
index 0d4d967..bbbb96c 100644
--- a/scons.1
+++ b/scons.1
@@ -3,11 +3,11 @@
.\" Author: Steven Knight
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: <pubdate>2004 - 2016</pubdate>
-.\" Manual: SCons 3.0.0
-.\" Source: SCons 3.0.0 version 3.0.0
+.\" Manual: SCons 3.0.1
+.\" Source: SCons 3.0.1 version 3.0.1
.\" Language: English
.\"
-.TH "SCONS" "1" "<pubdate>2004 - 2016</pubdate>" "SCons 3\&.0\&.0 version 3.0.0" "SCons 3\&.0\&.0"
+.TH "SCONS" "1" "<pubdate>2004 - 2016</pubdate>" "SCons 3\&.0\&.1 version 3.0.1" "SCons 3\&.0\&.1"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -606,7 +606,80 @@ option\&. This will be deprecated in some future release and ultimately removed\
.PP
\-\-debug=time
.RS 4
-Prints various time profiling information: the time spent executing each individual build command; the total build time (time SCons ran from beginning to end); the total time spent reading and executing SConscript files; the total time spent SCons itself spend running (that is, not counting reading and executing SConscript files); and both the total time spent executing all build commands and the elapsed wall\-clock time spent executing those build commands\&. (When
+Prints various time profiling information:
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+The time spent executing each individual build command.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+The total build time (time SCons ran from beginning to end).RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+The total time spent reading and executing SConscript files.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+The total time spent SCons itself spend running
+(that is, not counting reading and executing SConscript files).RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+The total time spent executing all build commands.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+The elapsed wall\-clock time spent executing those build commands.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+The time spent processing each file passed to the \fISConscript()\fR function.RE
+.sp
+(When
\fBscons\fR
is executed without the
\fB\-j\fR
@@ -3192,6 +3265,11 @@ Uses:
\fB$ASPPCOMSTR\fR\&.
.RE
.PP
+packaging
+.RS 4
+A framework for building binary and source packages\&.
+.RE
+.PP
Packaging
.RS 4
Sets construction variables for the
@@ -3199,11 +3277,6 @@ Sets construction variables for the
Builder\&.
.RE
.PP
-packaging
-.RS 4
-A framework for building binary and source packages\&.
-.RE
-.PP
pdf
.RS 4
Sets construction variables for the Portable Document Format builder\&.
@@ -12545,14 +12618,14 @@ General options passed to the Ghostscript program, when converting PostScript to
.PP
HOST_ARCH
.RS 4
+The name of the host hardware architecture used to create the Environment\&. If a platform is specified when creating the Environment, then that Platform\*(Aqs logic will handle setting this value\&. This value is immutable, and should not be changed by the user after the Environment is initialized\&. Currently only set for Win32\&.
+.sp
Sets the host architecture for Visual Studio compiler\&. If not set, default to the detected host architecture: note that this may depend on the python you are using\&. This variable must be passed as an argument to the Environment() constructor; setting it later has no effect\&.
.sp
Valid values are the same as for
\fB$TARGET_ARCH\fR\&.
.sp
This is currently only used on Windows, but in the future it will be used on other OSes as well\&.
-.sp
-The name of the host hardware architecture used to create the Environment\&. If a platform is specified when creating the Environment, then that Platform\*(Aqs logic will handle setting this value\&. This value is immutable, and should not be changed by the user after the Environment is initialized\&. Currently only set for Win32\&.
.RE
.PP
HOST_OS
@@ -15392,16 +15465,6 @@ versions should exist as alpha\-numeric, decimal\-delimited values as defined by
values include \*(Aq1\*(Aq, \*(Aq1\&.2\&.3\*(Aq, and \*(Aq1\&.2\&.gitaa412c8b\*(Aq\&.
.RE
.PP
-SHLIBVERSIONFLAGS
-.RS 4
-Extra flags added to
-\fB$SHLINKCOM\fR
-when building versioned
-\fBSharedLibrary\fR\&. These flags are only used when
-\fB$SHLIBVERSION\fR
-is set\&.
-.RE
-.PP
_SHLIBVERSIONFLAGS
.RS 4
This macro automatically introduces extra flags to
@@ -15418,6 +15481,16 @@ and some extra dynamically generated options (such as
\-Wl,\-soname=$_SHLIBSONAME\&. It is unused by "plain" (unversioned) shared libraries\&.
.RE
.PP
+SHLIBVERSIONFLAGS
+.RS 4
+Extra flags added to
+\fB$SHLINKCOM\fR
+when building versioned
+\fBSharedLibrary\fR\&. These flags are only used when
+\fB$SHLIBVERSION\fR
+is set\&.
+.RE
+.PP
SHLINK
.RS 4
The linker for programs that use shared libraries\&.
@@ -15767,6 +15840,8 @@ A reserved variable name that may not be set or used in a construction environme
.PP
TARGET_ARCH
.RS 4
+The name of the target hardware architecture for the compiled objects created by this Environment\&. This defaults to the value of HOST_ARCH, and the user can override it\&. Currently only set for Win32\&.
+.sp
Sets the target architecture for Visual Studio compiler (i\&.e\&. the arch of the binaries generated by the compiler)\&. If not set, default to
\fB$HOST_ARCH\fR, or, if that is unset, to the architecture of the running machine\*(Aqs OS (note that the python build or architecture has no effect)\&. This variable must be passed as an argument to the Environment() constructor; setting it later has no effect\&. This is currently only used on Windows, but in the future it will be used on other OSes as well\&.
.sp
@@ -15782,8 +15857,6 @@ ia64
(Itanium)\&. For example, if you want to compile 64\-bit binaries, you would set
TARGET_ARCH=\*(Aqx86_64\*(Aq
in your SCons environment\&.
-.sp
-The name of the target hardware architecture for the compiled objects created by this Environment\&. This defaults to the value of HOST_ARCH, and the user can override it\&. Currently only set for Win32\&.
.RE
.PP
TARGET_OS
@@ -17310,7 +17383,9 @@ function will cause the output to be sorted by the specified argument\&. The spe
\fIsort\fR
function should take two arguments and return \-1, 0 or 1 (like the standard Python
\fIcmp\fR
-function)\&.
+function)\&. Optionally a Boolean value of True for
+\fIsort\fR
+will cause a standard alphabetical sort to be performed
.sp
.if n \{\
.RS 4