diff options
author | Mats Wichmann <mats@linux.com> | 2020-12-19 19:47:54 (GMT) |
---|---|---|
committer | Mats Wichmann <mats@linux.com> | 2020-12-19 19:47:54 (GMT) |
commit | 0b0f7780bcf1ec7a39bfd5e6a741c47ff964ab0c (patch) | |
tree | 76fea0356b47c96ff58401587142ff2b59e6c057 /doc | |
parent | f729f569e1e6100ff01c8ecf8b62943c48143691 (diff) | |
download | SCons-0b0f7780bcf1ec7a39bfd5e6a741c47ff964ab0c.zip SCons-0b0f7780bcf1ec7a39bfd5e6a741c47ff964ab0c.tar.gz SCons-0b0f7780bcf1ec7a39bfd5e6a741c47ff964ab0c.tar.bz2 |
[PR #3844] adjust man wordings per review [ski appveyor]
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/scons.xml | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 70f47af..df38788 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -110,7 +110,7 @@ not have to be recalculated each run. </para> <para>You set up an &SCons; -build system by writing a configuration file +build system by writing a script that describes things to build (<firstterm>targets</firstterm>), and, if necessary, the rules to build those files (<firstterm>actions</firstterm>). &SCons; comes with a collection of <firstterm>Builder</firstterm> methods @@ -138,9 +138,7 @@ looks for a file named in the current directory and reads the build configuration from that file (other names are possible, -see <xref linkend="configuration_files"/> for more information). -An &SConstruct; file is required: -&scons; will quit if it does not find one. +see <xref linkend="sconscript_files"/> for more information). The &SConstruct; file may specify subsidiary configuration files by calling the @@ -2175,25 +2173,28 @@ repositories are searched in the order specified.</para> </variablelist> </refsect1> -<refsect1 id='configuration_file_reference'> -<title>CONFIGURATION FILE REFERENCE</title> +<refsect1 id='sconscript_file_reference'> +<title>SCONSCRIPT FILE REFERENCE</title> -<refsect2 id='configuration_files'> -<title>Configuration Files</title> +<refsect2 id='sconscript_files'> +<title>SConscript Files</title> <para> -The build configuration consists of one or more configuration files -(SConscript files). -The main file is named <filename>SConstruct</filename> by -default, though if necessary, &scons; also checks for alternate spellings +The build configuration is described by one or more files, +known as SConscript files. +There must be at least one file for a valid build +(&scons; will quit if it does not find one). +&scons; by default looks for this file by the name +<filename>SConstruct</filename> +in the directory from which you run &scons;, +though if necessary, also looks for alternative file names &Sconstruct;, &sconstruct;, &SConstruct.py;, &Sconstruct.py; -and &sconstruct.py; -in that order. -An alternate file name (including a path to another -directory) may be specified via the <option>-f</option> option. -Except for the main file, -these files are not searched for automatically by &scons; - -additional configuration files are added to the build -through calls to the &f-link-SConscript; function. +and &sconstruct.py; in that order. +A different file name (which can include a pathname part) +may be specified via the <option>-f</option> option. +Except for the SConstruct file, +these files are not searched for automatically; +you add additional configuration files to the build +by calling the &f-link-SConscript; function. This allows parts of the build to be conditionally included or excluded at run-time depending on how &scons; is invoked. </para> @@ -3421,8 +3422,8 @@ from SCons.Script import * <para>A &consenv; has an associated dictionary of <firstterm>&consvars;</firstterm> that are used by built-in or user-supplied build rules. -&Consvar; naming must follow the same rules as used for -Python identifiers: +&Consvar; naming must follow the same rules as +Python identifier naming: the initial character must be an underscore or letter, followed by any number of underscores, letters, or digits. A &consenv; is not a Python dictionary itself, |