summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/f95.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/f95.xml')
-rw-r--r--src/engine/SCons/Tool/f95.xml99
1 files changed, 79 insertions, 20 deletions
diff --git a/src/engine/SCons/Tool/f95.xml b/src/engine/SCons/Tool/f95.xml
index 5455f40..ab151a0 100644
--- a/src/engine/SCons/Tool/f95.xml
+++ b/src/engine/SCons/Tool/f95.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="f95">
<summary>
+<para>
Set construction variables for generic POSIX Fortran 95 compilers.
+</para>
</summary>
<sets>
-F95
-F95FLAGS
-F95COM
-F95PPCOM
-SHF95
-SHF95FLAGS
-SHF95COM
-SHF95PPCOM
-_F95INCFLAGS
+<item>F95</item>
+<item>F95FLAGS</item>
+<item>F95COM</item>
+<item>F95PPCOM</item>
+<item>SHF95</item>
+<item>SHF95FLAGS</item>
+<item>SHF95COM</item>
+<item>SHF95PPCOM</item>
+<item>_F95INCFLAGS</item>
</sets>
<uses>
-F95COMSTR
-F95PPCOMSTR
-SHF95COMSTR
-SHF95PPCOMSTR
+<item>F95COMSTR</item>
+<item>F95PPCOMSTR</item>
+<item>SHF95COMSTR</item>
+<item>SHF95PPCOMSTR</item>
</uses>
</tool>
<cvar name="F95">
<summary>
+<para>
The Fortran 95 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-F95; if you need to use a specific compiler
or compiler version for Fortran 95 files.
+</para>
</summary>
</cvar>
<cvar name="F95COM">
<summary>
+<para>
The command line used to compile a Fortran 95 source file to an object file.
You only need to set &cv-link-F95COM; if you need to use a specific
command line for Fortran 95 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="F95COMSTR">
<summary>
+<para>
The string displayed when a Fortran 95 source file
is compiled to an object file.
If this is not set, then &cv-link-F95COM; or &cv-link-FORTRANCOM;
(the command line) is displayed.
+</para>
</summary>
</cvar>
<cvar name="F95FILESUFFIXES">
<summary>
+<para>
The list of file extensions for which the F95 dialect will be used. By
default, this is ['.f95']
+</para>
</summary>
</cvar>
<cvar name="F95PPFILESUFFIXES">
<summary>
+<para>
The list of file extensions for which the compilation + preprocessor pass for
F95 dialect will be used. By default, this is empty
+</para>
</summary>
</cvar>
<cvar name="F95FLAGS">
<summary>
+<para>
General user-specified options that are passed to the Fortran 95 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="_F95INCFLAGS">
<summary>
+<para>
An automatically-generated construction variable
containing the Fortran 95 compiler command-line options
for specifying directories to be searched for include files.
@@ -103,11 +137,13 @@ The value of &cv-link-_F95INCFLAGS; is created
by appending &cv-link-INCPREFIX; and &cv-link-INCSUFFIX;
to the beginning and end
of each directory in &cv-link-F95PATH;.
+</para>
</summary>
</cvar>
<cvar name="F95PATH">
<summary>
+<para>
The list of directories that the Fortran 95 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(F95PATH='#/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(F95PATH=include)
-</example>
+</example_commands>
+<para>
The directory list will be added to command lines
through the automatically-generated
&cv-link-_F95INCFLAGS;
@@ -150,15 +190,17 @@ of each directory in &cv-link-F95PATH;.
Any command lines you define that need
the F95PATH directory list should
include &cv-link-_F95INCFLAGS;:
+</para>
-<example>
+<example_commands>
env = Environment(F95COM="my_compiler $_F95INCFLAGS -c -o $TARGET $SOURCE")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="F95PPCOM">
<summary>
+<para>
The command line used to compile a Fortran 95 source file to an object file
after first running the file through the C preprocessor.
Any options specified in the &cv-link-F95FLAGS; and &cv-link-CPPFLAGS; construction variables
@@ -168,32 +210,38 @@ C-preprocessor command line for Fortran 95 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="F95PPCOMSTR">
<summary>
+<para>
The string displayed when a Fortran 95 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-F95PPCOM; or &cv-link-FORTRANPPCOM;
(the command line) is displayed.
+</para>
</summary>
</cvar>
<cvar name="SHF95">
<summary>
+<para>
The Fortran 95 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-SHF95; if you need to use a specific compiler
or compiler version for Fortran 95 files.
+</para>
</summary>
</cvar>
<cvar name="SHF95COM">
<summary>
+<para>
The command line used to compile a Fortran 95 source file
to a shared-library object file.
You only need to set &cv-link-SHF95COM; if you need to use a specific
@@ -201,20 +249,24 @@ command line for Fortran 95 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="SHF95COMSTR">
<summary>
+<para>
The string displayed when a Fortran 95 source file
is compiled to a shared-library object file.
If this is not set, then &cv-link-SHF95COM; or &cv-link-SHFORTRANCOM;
(the command line) is displayed.
+</para>
</summary>
</cvar>
<cvar name="SHF95FLAGS">
<summary>
+<para>
Options that are passed to the Fortran 95 compiler
to generated shared-library objects.
You only need to set &cv-link-SHF95FLAGS; 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="SHF95PPCOM">
<summary>
+<para>
The command line used to compile a Fortran 95 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 95 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="SHF95PPCOMSTR">
<summary>
+<para>
The string displayed when a Fortran 95 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-SHF95PPCOM; or &cv-link-SHFORTRANPPCOM;
(the command line) is displayed.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file