diff options
Diffstat (limited to 'src/engine/SCons/Tool/cc.xml')
| -rw-r--r-- | src/engine/SCons/Tool/cc.xml | 99 |
1 files changed, 73 insertions, 26 deletions
diff --git a/src/engine/SCons/Tool/cc.xml b/src/engine/SCons/Tool/cc.xml index 1860c25..ec2b5ee 100644 --- a/src/engine/SCons/Tool/cc.xml +++ b/src/engine/SCons/Tool/cc.xml @@ -1,79 +1,111 @@ +<?xml version="1.0" encoding="UTF-8"?> <!-- -Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation +Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation This file is processed by the bin/SConsDoc.py module. See its __doc__ string for a discussion of the format. --> + +<!DOCTYPE sconsdoc [ +<!ENTITY % scons SYSTEM '../../../../doc/scons.mod'> +%scons; +<!ENTITY % builders-mod SYSTEM '../../../../doc/generated/builders.mod'> +%builders-mod; +<!ENTITY % functions-mod SYSTEM '../../../../doc/generated/functions.mod'> +%functions-mod; +<!ENTITY % tools-mod SYSTEM '../../../../doc/generated/tools.mod'> +%tools-mod; +<!ENTITY % variables-mod SYSTEM '../../../../doc/generated/variables.mod'> +%variables-mod; +]> + +<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd"> + <tool name="cc"> <summary> +<para> Sets construction variables for generic POSIX C copmilers. +</para> </summary> <sets> -<!--_CCCOMCOM--> -FRAMEWORKS -FRAMEWORKPATH -CC -CFLAGS -CCFLAGS -CCCOM -SHCC -SHCFLAGS -SHCCFLAGS -SHCCCOM -CPPDEFPREFIX -CPPDEFSUFFIX -INCPREFIX -INCSUFFIX -SHOBJSUFFIX -<!--STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME--> -CFILESUFFIX +<item><!--_CCCOMCOM--></item> +<item>FRAMEWORKS</item> +<item>FRAMEWORKPATH</item> +<item>CC</item> +<item>CFLAGS</item> +<item>CCFLAGS</item> +<item>CCCOM</item> +<item>SHCC</item> +<item>SHCFLAGS</item> +<item>SHCCFLAGS</item> +<item>SHCCCOM</item> +<item>CPPDEFPREFIX</item> +<item>CPPDEFSUFFIX</item> +<item>INCPREFIX</item> +<item>INCSUFFIX</item> +<item>SHOBJSUFFIX</item> +<item><!--STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME--></item> +<item>CFILESUFFIX</item> </sets> <uses> -PLATFORM +<item>PLATFORM</item> </uses> </tool> <cvar name="CC"> <summary> +<para> The C compiler. +</para> </summary> </cvar> <cvar name="CCCOM"> <summary> +<para> The command line used to compile a C source file to a (static) object file. Any options specified in the &cv-link-CFLAGS;, &cv-link-CCFLAGS; and &cv-link-CPPFLAGS; construction variables are included on this command line. +</para> </summary> </cvar> <cvar name="CCCOMSTR"> <summary> +<para> The string displayed when a C source file is compiled to a (static) object file. If this is not set, then &cv-link-CCCOM; (the command line) is displayed. +</para> -<example> +<example_commands> env = Environment(CCCOMSTR = "Compiling static object $TARGET") -</example> +</example_commands> </summary> </cvar> <cvar name="CCFLAGS"> <summary> +<para> General options that are passed to the C and C++ compilers. +</para> </summary> </cvar> <cvar name="CFLAGS"> <summary> +<para> General options that are passed to the C compiler (C only; not C++). +</para> </summary> </cvar> <cvar name="CPPFLAGS"> <summary> +<para> User-specified C preprocessor options. These will be included in any command that uses the C preprocessor, including not just compilation of C and C++ source files @@ -97,65 +129,80 @@ contain that scons generates automatically from &cv-link-CPPPATH;. See &cv-link-_CPPINCFLAGS;, below, for the variable that expands to those options. +</para> </summary> </cvar> <cvar name="CPPSUFFIXES"> <summary> +<para> The list of suffixes of files that will be scanned for C preprocessor implicit dependencies (#include lines). The default list is: +</para> -<example> +<example_commands> [".c", ".C", ".cxx", ".cpp", ".c++", ".cc", ".h", ".H", ".hxx", ".hpp", ".hh", ".F", ".fpp", ".FPP", ".m", ".mm", ".S", ".spp", ".SPP"] -</example> +</example_commands> </summary> </cvar> <cvar name="SHCC"> <summary> +<para> The C compiler used for generating shared-library objects. +</para> </summary> </cvar> <cvar name="SHCCCOM"> <summary> +<para> The command line used to compile a C source file to a shared-library object file. Any options specified in the &cv-link-SHCFLAGS;, &cv-link-SHCCFLAGS; and &cv-link-CPPFLAGS; construction variables are included on this command line. +</para> </summary> </cvar> <cvar name="SHCCCOMSTR"> <summary> +<para> The string displayed when a C source file is compiled to a shared object file. If this is not set, then &cv-link-SHCCCOM; (the command line) is displayed. +</para> -<example> +<example_commands> env = Environment(SHCCCOMSTR = "Compiling shared object $TARGET") -</example> +</example_commands> </summary> </cvar> <cvar name="SHCCFLAGS"> <summary> +<para> Options that are passed to the C and C++ compilers to generate shared-library objects. +</para> </summary> </cvar> <cvar name="SHCFLAGS"> <summary> +<para> Options that are passed to the C compiler (only; not C++) to generate shared-library objects. +</para> </summary> </cvar> + +</sconsdoc>
\ No newline at end of file |