diff options
Diffstat (limited to 'src/engine/SCons/Platform/__init__.xml')
| -rw-r--r-- | src/engine/SCons/Platform/__init__.xml | 183 |
1 files changed, 183 insertions, 0 deletions
diff --git a/src/engine/SCons/Platform/__init__.xml b/src/engine/SCons/Platform/__init__.xml new file mode 100644 index 0000000..dc5a415 --- /dev/null +++ b/src/engine/SCons/Platform/__init__.xml @@ -0,0 +1,183 @@ +<!-- +Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> +<cvar name="ESCAPE"> +<summary> +A function that will be called to escape shell special characters in +command lines. The function should take one argument: the command line +string to escape; and should return the escaped command line. +</summary> +</cvar> + +<cvar name="LIBPREFIX"> +<summary> +The prefix used for (static) library file names. +A default value is set for each platform +(posix, win32, os2, etc.), +but the value is overridden by individual tools +(ar, mslib, sgiar, sunar, tlib, etc.) +to reflect the names of the libraries they create. +</summary> +</cvar> + +<cvar name="LIBPREFIXES"> +<summary> +A list of all legal prefixes for library file names. +When searching for library dependencies, +SCons will look for files with these prefixes, +the base library name, +and suffixes in the &cv-LIBSUFFIXES; list. +</summary> +</cvar> + +<cvar name="LIBSUFFIX"> +<summary> +The suffix used for (static) library file names. +A default value is set for each platform +(posix, win32, os2, etc.), +but the value is overridden by individual tools +(ar, mslib, sgiar, sunar, tlib, etc.) +to reflect the names of the libraries they create. +</summary> +</cvar> + +<cvar name="LIBSUFFIXES"> +<summary> +A list of all legal suffixes for library file names. +When searching for library dependencies, +SCons will look for files with prefixes, in the &cv-LIBPREFIXES; list, +the base library name, +and these suffixes. +</summary> +</cvar> + +<cvar name="OBJPREFIX"> +<summary> +The prefix used for (static) object file names. +</summary> +</cvar> + +<cvar name="OBJSUFFIX"> +<summary> +The suffix used for (static) object file names. +</summary> +</cvar> + +<cvar name="PLATFORM"> +<summary> +The name of the platform used to create the Environment. If no platform is +specified when the Environment is created, +&scons; +autodetects the platform. + +<example> +env = Environment(tools = []) +if env['PLATFORM'] == 'cygwin': + Tool('mingw')(env) +else: + Tool('msvc')(env) +</example> +</summary> +</cvar> + +<cvar name="HOST_OS"> + <summary> + The name of the host operating system used to create the Environment. + If a platform is specified when creating the Environment, then + that Platform's 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. + </summary> +</cvar> + +<cvar name="HOST_ARCH"> + <summary> + The name of the host hardware architecture used to create the Environment. + If a platform is specified when creating the Environment, then + that Platform's 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. + </summary> +</cvar> + +<cvar name="TARGET_OS"> + <summary> + The name of the target operating system for the compiled objects + created by this Environment. + This defaults to the value of HOST_OS, and the user can override it. + Currently only set for Win32. + </summary> +</cvar> + +<cvar name="TARGET_ARCH"> + <summary> + 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. + </summary> +</cvar> + + +<cvar name="PROGPREFIX"> +<summary> +The prefix used for executable file names. +</summary> +</cvar> + +<cvar name="PROGSUFFIX"> +<summary> +The suffix used for executable file names. +</summary> +</cvar> + +<cvar name="SHELL"> +<summary> +A string naming the shell program that will be passed to the +&cv-SPAWN; +function. +See the +&cv-SPAWN; +construction variable for more information. +</summary> +</cvar> + +<cvar name="SHLIBPREFIX"> +<summary> +The prefix used for shared library file names. +</summary> +</cvar> + +<cvar name="SHLIBSUFFIX"> +<summary> +The suffix used for shared library file names. +</summary> +</cvar> + +<cvar name="SHOBJPREFIX"> +<summary> +The prefix used for shared object file names. +</summary> +</cvar> + +<cvar name="SHOBJSUFFIX"> +<summary> +The suffix used for shared object file names. +</summary> +</cvar> + +<cvar name="TEMPFILEPREFIX"> +<summary> +The prefix for a temporary file used +to execute lines longer than $MAXLINELENGTH. +The default is '@'. +This may be set for toolchains that use other values, +such as '-@' for the diab compiler +or '-via' for ARM toolchain. +</summary> +</cvar> |