summaryrefslogtreecommitdiffstats
path: root/doc/generated/variables.gen
diff options
context:
space:
mode:
authorMats Wichmann <mats@linux.com>2020-06-10 17:09:09 (GMT)
committerMats Wichmann <mats@linux.com>2020-06-10 17:12:42 (GMT)
commit2f5841806011b1ca123e58ddaa55e4319b5468da (patch)
tree44c9910e3aa95d45766d6b67a7a3ca5987c3036e /doc/generated/variables.gen
parent07ba4716ef08158da819ec98b4533d06c84c12dc (diff)
downloadSCons-2f5841806011b1ca123e58ddaa55e4319b5468da.zip
SCons-2f5841806011b1ca123e58ddaa55e4319b5468da.tar.gz
SCons-2f5841806011b1ca123e58ddaa55e4319b5468da.tar.bz2
Documentation updates in perparation for 4.0 [ci skip]
* Switch API docs to readthedocs theme * Add links in manpage SEE ALSO to external websites. These are not just live, but also listed out (Linux manpages won't have the hyperlinks) * Links use docbook5 xlink:href instead of deprecated (claimed to be removed, but apparently not) ulink syntax * Comment out manpage Examples section, and leave a pointer to scons-cookbook.readthedocs.io instead * Regenerate everything, mainly to pick up compilation_db stuff. Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'doc/generated/variables.gen')
-rw-r--r--doc/generated/variables.gen55
1 files changed, 39 insertions, 16 deletions
diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen
index 8c22b79..3795aab 100644
--- a/doc/generated/variables.gen
+++ b/doc/generated/variables.gen
@@ -557,6 +557,29 @@ section of the RPM
</para>
</listitem>
</varlistentry>
+ <varlistentry id="cv-COMPILATIONDB_COMSTR">
+ <term>
+ <envar>COMPILATIONDB_COMSTR</envar>
+ </term>
+ <listitem><para>
+ The string displayed when CompilationDatabase builder's action is run.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="cv-COMPILATIONDB_USE_ABSPATH">
+ <term>
+ <envar>COMPILATIONDB_USE_ABSPATH</envar>
+ </term>
+ <listitem><para>
+ This is a boolean flag to instruct <link linkend="b-CompilationDatabase"><function>CompilationDatabase</function></link> to
+ write the <literal>file</literal> and <literal>target</literal> members
+ in the compilation database with absolute or relative paths.
+ </para>
+ <para>
+ The default value is False (use relative paths)
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry id="cv-_concat">
<term>
<envar>_concat</envar>
@@ -3015,14 +3038,6 @@ is <quote><literal>-dNOPAUSE -dBATCH -sDEVICE=pdfwrite</literal></quote>
<envar>HOST_ARCH</envar>
</term>
<listitem><para>
- 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.
-</para>
- <para>
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.
@@ -3038,7 +3053,15 @@ Valid values are the same as for <envar>$TARGET_ARCH</envar>.
This is currently only used on Windows, but in the future it will be
used on other OSes as well.
</para>
-</listitem>
+<para>
+ 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.
+</para>
+ </listitem>
</varlistentry>
<varlistentry id="cv-HOST_OS">
<term>
@@ -7628,12 +7651,6 @@ for more information).
<envar>TARGET_ARCH</envar>
</term>
<listitem><para>
- 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.
-</para>
- <para>
Sets the target architecture for Visual Studio compiler (i.e. the arch
of the binaries generated by the compiler). If not set, default to
<envar>$HOST_ARCH</envar>, or, if that is unset, to the architecture of the
@@ -7664,7 +7681,13 @@ and <literal>ia64</literal> (Itanium).
For example, if you want to compile 64-bit binaries, you would set
<literal>TARGET_ARCH='x86_64'</literal> in your SCons environment.
</para>
-</listitem>
+<para>
+ 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.
+</para>
+ </listitem>
</varlistentry>
<varlistentry id="cv-TARGET_OS">
<term>