diff options
Diffstat (limited to 'src/engine/SCons/Tool/f03.xml')
| -rw-r--r-- | src/engine/SCons/Tool/f03.xml | 99 |
1 files changed, 79 insertions, 20 deletions
diff --git a/src/engine/SCons/Tool/f03.xml b/src/engine/SCons/Tool/f03.xml index fa16a56..bc2bf26 100644 --- a/src/engine/SCons/Tool/f03.xml +++ b/src/engine/SCons/Tool/f03.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="f03"> <summary> +<para> Set construction variables for generic POSIX Fortran 03 compilers. +</para> </summary> <sets> -F03 -F03FLAGS -F03COM -F03PPCOM -SHF03 -SHF03FLAGS -SHF03COM -SHF03PPCOM -_F03INCFLAGS +<item>F03</item> +<item>F03FLAGS</item> +<item>F03COM</item> +<item>F03PPCOM</item> +<item>SHF03</item> +<item>SHF03FLAGS</item> +<item>SHF03COM</item> +<item>SHF03PPCOM</item> +<item>_F03INCFLAGS</item> </sets> <uses> -F03COMSTR -F03PPCOMSTR -SHF03COMSTR -SHF03PPCOMSTR +<item>F03COMSTR</item> +<item>F03PPCOMSTR</item> +<item>SHF03COMSTR</item> +<item>SHF03PPCOMSTR</item> </uses> </tool> <cvar name="F03"> <summary> +<para> The Fortran 03 compiler. You should normally set the &cv-link-FORTRAN; variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set &cv-link-F03; if you need to use a specific compiler or compiler version for Fortran 03 files. +</para> </summary> </cvar> <cvar name="F03COM"> <summary> +<para> The command line used to compile a Fortran 03 source file to an object file. You only need to set &cv-link-F03COM; if you need to use a specific command line for Fortran 03 files. You should normally set the &cv-link-FORTRANCOM; variable, which specifies the default command line for all Fortran versions. +</para> </summary> </cvar> <cvar name="F03COMSTR"> <summary> +<para> The string displayed when a Fortran 03 source file is compiled to an object file. If this is not set, then &cv-link-F03COM; or &cv-link-FORTRANCOM; (the command line) is displayed. +</para> </summary> </cvar> <cvar name="F03FILESUFFIXES"> <summary> +<para> The list of file extensions for which the F03 dialect will be used. By default, this is ['.f03'] +</para> </summary> </cvar> <cvar name="F03PPFILESUFFIXES"> <summary> +<para> The list of file extensions for which the compilation + preprocessor pass for F03 dialect will be used. By default, this is empty +</para> </summary> </cvar> <cvar name="F03FLAGS"> <summary> +<para> General user-specified options that are passed to the Fortran 03 compiler. Note that this variable does <emphasis>not</emphasis> @@ -91,11 +123,13 @@ You should normally set the &cv-link-FORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. +</para> </summary> </cvar> <cvar name="_F03INCFLAGS"> <summary> +<para> An automatically-generated construction variable containing the Fortran 03 compiler command-line options for specifying directories to be searched for include files. @@ -103,11 +137,13 @@ The value of &cv-link-_F03INCFLAGS; is created by appending &cv-link-INCPREFIX; and &cv-link-INCSUFFIX; to the beginning and end of each directory in &cv-link-F03PATH;. +</para> </summary> </cvar> <cvar name="F03PATH"> <summary> +<para> The list of directories that the Fortran 03 compiler will search for include directories. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory @@ -123,20 +159,24 @@ You should normally set the &cv-link-FORTRANPATH; variable, which specifies the include path for the default Fortran compiler for all Fortran versions. +</para> -<example> +<example_commands> env = Environment(F03PATH='#/include') -</example> +</example_commands> +<para> The directory look-up can also be forced using the &Dir;() function: +</para> -<example> +<example_commands> include = Dir('include') env = Environment(F03PATH=include) -</example> +</example_commands> +<para> The directory list will be added to command lines through the automatically-generated &cv-link-_F03INCFLAGS; @@ -150,15 +190,17 @@ of each directory in &cv-link-F03PATH;. Any command lines you define that need the F03PATH directory list should include &cv-link-_F03INCFLAGS;: +</para> -<example> +<example_commands> env = Environment(F03COM="my_compiler $_F03INCFLAGS -c -o $TARGET $SOURCE") -</example> +</example_commands> </summary> </cvar> <cvar name="F03PPCOM"> <summary> +<para> The command line used to compile a Fortran 03 source file to an object file after first running the file through the C preprocessor. Any options specified in the &cv-link-F03FLAGS; and &cv-link-CPPFLAGS; construction variables @@ -168,32 +210,38 @@ C-preprocessor command line for Fortran 03 files. You should normally set the &cv-link-FORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. +</para> </summary> </cvar> <cvar name="F03PPCOMSTR"> <summary> +<para> The string displayed when a Fortran 03 source file is compiled to an object file after first running the file through the C preprocessor. If this is not set, then &cv-link-F03PPCOM; or &cv-link-FORTRANPPCOM; (the command line) is displayed. +</para> </summary> </cvar> <cvar name="SHF03"> <summary> +<para> The Fortran 03 compiler used for generating shared-library objects. You should normally set the &cv-link-SHFORTRAN; variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set &cv-link-SHF03; if you need to use a specific compiler or compiler version for Fortran 03 files. +</para> </summary> </cvar> <cvar name="SHF03COM"> <summary> +<para> The command line used to compile a Fortran 03 source file to a shared-library object file. You only need to set &cv-link-SHF03COM; if you need to use a specific @@ -201,20 +249,24 @@ command line for Fortran 03 files. You should normally set the &cv-link-SHFORTRANCOM; variable, which specifies the default command line for all Fortran versions. +</para> </summary> </cvar> <cvar name="SHF03COMSTR"> <summary> +<para> The string displayed when a Fortran 03 source file is compiled to a shared-library object file. If this is not set, then &cv-link-SHF03COM; or &cv-link-SHFORTRANCOM; (the command line) is displayed. +</para> </summary> </cvar> <cvar name="SHF03FLAGS"> <summary> +<para> Options that are passed to the Fortran 03 compiler to generated shared-library objects. You only need to set &cv-link-SHF03FLAGS; if you need to define specific @@ -223,11 +275,13 @@ You should normally set the &cv-link-SHFORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. +</para> </summary> </cvar> <cvar name="SHF03PPCOM"> <summary> +<para> The command line used to compile a Fortran 03 source file to a shared-library object file after first running the file through the C preprocessor. @@ -238,15 +292,20 @@ C-preprocessor command line for Fortran 03 files. You should normally set the &cv-link-SHFORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. +</para> </summary> </cvar> <cvar name="SHF03PPCOMSTR"> <summary> +<para> The string displayed when a Fortran 03 source file is compiled to a shared-library object file after first running the file through the C preprocessor. If this is not set, then &cv-link-SHF03PPCOM; or &cv-link-SHFORTRANPPCOM; (the command line) is displayed. +</para> </summary> </cvar> + +</sconsdoc>
\ No newline at end of file |