diff options
| author | William Deegan <bill@baddogconsulting.com> | 2024-11-16 22:26:21 (GMT) |
|---|---|---|
| committer | William Deegan <bill@baddogconsulting.com> | 2024-11-16 22:26:21 (GMT) |
| commit | e73b7d350d1e0aa005bd72b44dc5b067e30dc58e (patch) | |
| tree | 1983e7316972a3c89c2deff73aacee301903c94a | |
| parent | 33077115417396603cb38d74d813332dadceb7ee (diff) | |
| download | SCons-e73b7d350d1e0aa005bd72b44dc5b067e30dc58e.zip SCons-e73b7d350d1e0aa005bd72b44dc5b067e30dc58e.tar.gz SCons-e73b7d350d1e0aa005bd72b44dc5b067e30dc58e.tar.bz2 | |
[ci skip] update generated files
| -rw-r--r-- | doc/generated/builders.gen | 601 | ||||
| -rw-r--r-- | doc/generated/examples/caching_ex-random_1.xml | 6 | ||||
| -rw-r--r-- | doc/generated/examples/commandline_PackageVariable_1.xml | 2 | ||||
| -rw-r--r-- | doc/generated/examples/troubleshoot_explain1_3.xml | 2 | ||||
| -rw-r--r-- | doc/generated/examples/troubleshoot_taskmastertrace_1.xml | 50 | ||||
| -rw-r--r-- | doc/generated/functions.gen | 238 | ||||
| -rw-r--r-- | doc/generated/tools.gen | 75 | ||||
| -rw-r--r-- | doc/generated/variables.gen | 140 |
8 files changed, 600 insertions, 514 deletions
diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index d0ee3dd..cfcb361 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -47,7 +47,7 @@ This is useful for "one-off" builds where a full Builder is not needed. Since the anonymous Builder is never hooked into the standard Builder framework, -an Action must always be specfied. +an Action must always be specified. See the &f-link-Command; function description for the calling syntax and details. </para> @@ -474,7 +474,7 @@ in this case. If the <option>--install-sandbox</option> command line option is given, the target directory will be prefixed by the directory path specified. -This is useful to test installs without installing to +This is useful to test installation behavior without installing to a "live" location in the system. </para> @@ -642,8 +642,8 @@ env.Java(target='classes', source=['File1.java', 'File2.java']) In this case, the user must specify the <literal>LANG</literal> environment variable to tell the compiler what encoding is used. - For portibility, it's best if the encoding is hard-coded - so that the compile will work if it is done on a system + For portability, it's best if the encoding is hard-coded, + so that the compilation works when run on a system with a different encoding. </para> @@ -787,8 +787,12 @@ env.Moc('foo.cpp') # generates foo.moc <term><function>MOFiles</function>()</term> <term><replaceable>env</replaceable>.<methodname>MOFiles</methodname>()</term> <listitem><para> -This builder belongs to &t-link-msgfmt; tool. The builder compiles +This builder is set up by the &t-link-msgfmt; tool. +The builder compiles <literal>PO</literal> files to <literal>MO</literal> files. +&b-MOFiles; is a single-source builder. +The <parameter>source</parameter> parameter +can also be omitted if &cv-link-LINGUAS_FILE; is set. </para> <para> @@ -796,19 +800,17 @@ This builder belongs to &t-link-msgfmt; tool. The builder compiles Create <filename>pl.mo</filename> and <filename>en.mo</filename> by compiling <filename>pl.po</filename> and <filename>en.po</filename>: </para> -<example_commands> - # ... - env.MOFiles(['pl', 'en']) -</example_commands> +<programlisting language="python"> +env.MOFiles(['pl', 'en']) +</programlisting> <para> <emphasis>Example 2</emphasis>. Compile files for languages defined in <filename>LINGUAS</filename> file: </para> -<example_commands> - # ... - env.MOFiles(LINGUAS_FILE = 1) -</example_commands> +<programlisting language="python"> +env.MOFiles(LINGUAS_FILE=True) +</programlisting> <para> <emphasis>Example 3</emphasis>. @@ -816,21 +818,19 @@ Create <filename>pl.mo</filename> and <filename>en.mo</filename> by compiling <filename>pl.po</filename> and <filename>en.po</filename> plus files for languages defined in <filename>LINGUAS</filename> file: </para> -<example_commands> - # ... - env.MOFiles(['pl', 'en'], LINGUAS_FILE = 1) -</example_commands> +<programlisting language="python"> +env.MOFiles(['pl', 'en'], LINGUAS_FILE=True) +</programlisting> <para> <emphasis>Example 4</emphasis>. Compile files for languages defined in <filename>LINGUAS</filename> file (another version): </para> -<example_commands> - # ... - env['LINGUAS_FILE'] = 1 - env.MOFiles() -</example_commands> +<programlisting language="python"> +env['LINGUAS_FILE'] = True +env.MOFiles() +</programlisting> </listitem> </varlistentry> <varlistentry id="b-MSVSProject"> @@ -1075,7 +1075,7 @@ Compile files for languages defined in <filename>LINGUAS</filename> file "build" from the Visual Studio interface) you lose the direct control of target selection and command-line options you would have if launching the build directly from &SCons;, - because these will be hardcoded in the project file to the + because these will be hard-coded in the project file to the values specified in the &b-MSVSProject; call. You can regain some of this control by defining multiple variants, using multiple &b-MSVSProject; calls to arrange different build @@ -1088,7 +1088,7 @@ Compile files for languages defined in <filename>LINGUAS</filename> file it is important not to set Visual Studio to do parallel builds, as it will then launch the separate project builds in parallel, and &SCons; does not work well if called that way. - Instead you can set up the &SCons; build for parallel building - + Instead, you can set up the &SCons; build for parallel building - see the &f-link-SetOption; function for how to do this with <parameter>num_jobs</parameter>. </para> @@ -1234,7 +1234,7 @@ V10DebugSettings = { } # -# 3. Select the dictionary you want depending on the version of visual Studio +# 3. Select the dictionary you want depending on the version of Visual Studio # Files you want to generate. # if not env.GetOption('userfile'): @@ -1337,6 +1337,74 @@ env.MSVSProject( </listitem> </varlistentry> </variablelist> + <para> + In addition to the mandatory arguments above, the following optional + values may be specified as keyword arguments: + </para> + <variablelist> + <varlistentry> + <term><parameter>auto_filter_projects</parameter></term> + <listitem> + <para> + Under certain circumstances, solution file names or + solution file nodes may be present in the + <parameter>projects</parameter> argument list. + When solution file names or nodes are present in the + <parameter>projects</parameter> argument list, the generated + solution file may contain erroneous Project records resulting + in VS IDE error messages when opening the generated solution + file. + By default, an exception is raised when a solution file + name or solution file node is detected in the + <parameter>projects</parameter> argument list. + </para> + <para> + The accepted values for <parameter>auto_filter_projects</parameter> + are: + </para> + <variablelist> + <varlistentry> + <term><parameter>None</parameter></term> + <listitem> + <para> + An exception is raised when a solution file name or solution + file node is detected in the <parameter>projects</parameter> + argument list. + </para> + <para> + <parameter>None</parameter> is the default value. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>True or evaluates True</parameter></term> + <listitem> + <para> + Automatically remove solution file names and solution file + nodes from the <parameter>projects</parameter> argument list. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>False or evaluates False</parameter></term> + <listitem> + <para> + Leave the solution file names and solution file nodes + in the <parameter>projects</parameter> argument list. + An exception is not raised. + </para> + <para> + When opening the generated solution file with the VS IDE, + the VS IDE will likely report that there are erroneous + Project records that are not supported or that need to be + modified. + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + </variablelist> <para>Example Usage:</para> <example_commands> env.MSVSSolution( @@ -1442,7 +1510,7 @@ env = Environment(tools=['default', 'packaging']) <para> &SCons; can build packages in a number of well known packaging formats. The target package type may be selected with the -the &cv-link-PACKAGETYPE; construction variable +&cv-link-PACKAGETYPE; construction variable or the <option>--package-type</option> command line option. The package type may be a list, in which case &SCons; will attempt to build packages for each type in the list. Example: @@ -1460,7 +1528,7 @@ The currently supported packagers are: <tgroup cols="2"> <tbody> <row><entry><literal>msi</literal></entry><entry>Microsoft Installer package</entry></row> -<row><entry><literal>rpm</literal></entry><entry>RPM Package Manger package</entry></row> +<row><entry><literal>rpm</literal></entry><entry>RPM Package Manager package</entry></row> <row><entry><literal>ipkg</literal></entry><entry>Itsy Package Management package</entry></row> <row><entry><literal>tarbz2</literal></entry><entry>bzip2-compressed tar file</entry></row> <row><entry><literal>targz</literal></entry><entry>gzip-compressed tar file</entry></row> @@ -1606,41 +1674,48 @@ or The suffix specified by the &cv-link-PDFSUFFIX; construction variable (<filename>.pdf</filename> by default) is added automatically to the target -if it is not already present. Example: +if it is not already present. +&b-PDF; is a single-source builder. +Example: </para> -<example_commands> +<programlisting language="python"> # builds from aaa.tex env.PDF(target = 'aaa.pdf', source = 'aaa.tex') # builds bbb.pdf from bbb.dvi env.PDF(target = 'bbb', source = 'bbb.dvi') -</example_commands> +</programlisting> </listitem> </varlistentry> <varlistentry id="b-POInit"> <term><function>POInit</function>()</term> <term><replaceable>env</replaceable>.<methodname>POInit</methodname>()</term> <listitem><para> -This builder belongs to &t-link-msginit; tool. The builder initializes missing -<literal>PO</literal> file(s) if &cv-link-POAUTOINIT; is set. If -&cv-link-POAUTOINIT; is not set (default), &b-POInit; prints instruction for -user (that is supposed to be a translator), telling how the -<literal>PO</literal> file should be initialized. In normal projects +This builder is set up by the &t-link-msginit; tool. +The builder initializes missing +<literal>PO</literal> file(s) if &cv-link-POAUTOINIT; is set. +If &cv-link-POAUTOINIT; is not set (the default), +&b-POInit; prints instruction for the user (such as a translator), +telling how the <literal>PO</literal> file should be initialized. +In normal projects <emphasis>you should not use &b-POInit; and use &b-link-POUpdate; instead</emphasis>. &b-link-POUpdate; chooses intelligently between <command>msgmerge(1)</command> and <command>msginit(1)</command>. &b-POInit; always uses <command>msginit(1)</command> and should be regarded as builder for special purposes or for temporary use (e.g. for quick, one time initialization of a bunch of <literal>PO</literal> files) or for tests. +&b-POInit; is a single-source builder. +The <parameter>source</parameter> parameter +can also be omitted if &cv-link-LINGUAS_FILE; is set. </para> <para> Target nodes defined through &b-POInit; are not built by default (they're <literal>Ignore</literal>d from <literal>'.'</literal> node) but are added to -special <literal>Alias</literal> (<literal>'po-create'</literal> by default). +special &f-link-Alias; (<literal>'po-create'</literal> by default). The alias name may be changed through the &cv-link-POCREATE_ALIAS; -construction variable. All <literal>PO</literal> files defined through -&b-POInit; may be easily initialized by <command>scons po-create</command>. +&consvar;. All <literal>PO</literal> files defined through +&b-POInit; may be easily initialized by <userinput>scons po-create</userinput>. </para> <para> @@ -1648,31 +1723,27 @@ construction variable. All <literal>PO</literal> files defined through Initialize <filename>en.po</filename> and <filename>pl.po</filename> from <filename>messages.pot</filename>: </para> -<example_commands> - # ... - env.POInit(['en', 'pl']) # messages.pot --> [en.po, pl.po] -</example_commands> +<programlisting language="python"> +env.POInit(['en', 'pl']) # messages.pot --> [en.po, pl.po] +</programlisting> <para> <emphasis>Example 2</emphasis>. Initialize <filename>en.po</filename> and <filename>pl.po</filename> from <filename>foo.pot</filename>: </para> -<example_commands> - # ... - env.POInit(['en', 'pl'], ['foo']) # foo.pot --> [en.po, pl.po] -</example_commands> +<programlisting language="python"> +env.POInit(['en', 'pl'], ['foo']) # foo.pot --> [en.po, pl.po] +</programlisting> <para> <emphasis>Example 3</emphasis>. Initialize <filename>en.po</filename> and <filename>pl.po</filename> from -<filename>foo.pot</filename> but using &cv-link-POTDOMAIN; construction -variable: +<filename>foo.pot</filename> but using the &cv-link-POTDOMAIN; &consvar;: </para> -<example_commands> - # ... - env.POInit(['en', 'pl'], POTDOMAIN='foo') # foo.pot --> [en.po, pl.po] -</example_commands> +<programlisting language="python"> +env.POInit(['en', 'pl'], POTDOMAIN='foo') # foo.pot --> [en.po, pl.po] +</programlisting> <para> <emphasis>Example 4</emphasis>. @@ -1680,10 +1751,9 @@ Initialize <literal>PO</literal> files for languages defined in <filename>LINGUAS</filename> file. The files will be initialized from template <filename>messages.pot</filename>: </para> -<example_commands> - # ... - env.POInit(LINGUAS_FILE = 1) # needs 'LINGUAS' file -</example_commands> +<programlisting language="python"> +env.POInit(LINGUAS_FILE=True) # needs 'LINGUAS' file +</programlisting> <para> <emphasis>Example 5</emphasis>. @@ -1692,30 +1762,27 @@ Initialize <filename>en.po</filename> and <filename>pl.pl</filename> <filename>LINGUAS</filename> file. The files will be initialized from template <filename>messages.pot</filename>: </para> -<example_commands> - # ... - env.POInit(['en', 'pl'], LINGUAS_FILE = 1) -</example_commands> +<programlisting language="python"> +env.POInit(['en', 'pl'], LINGUAS_FILE=True) +</programlisting> <para> <emphasis>Example 6</emphasis>. You may preconfigure your environment first, and then initialize <literal>PO</literal> files: </para> -<example_commands> - # ... - env['POAUTOINIT'] = 1 - env['LINGUAS_FILE'] = 1 - env['POTDOMAIN'] = 'foo' - env.POInit() -</example_commands> +<programlisting language="python"> +env['POAUTOINIT'] = True +env['LINGUAS_FILE'] = True +env['POTDOMAIN'] = 'foo' +env.POInit() +</programlisting> <para> which has same efect as: </para> -<example_commands> - # ... - env.POInit(POAUTOINIT = 1, LINGUAS_FILE = 1, POTDOMAIN = 'foo') -</example_commands> +<programlisting language="python"> +env.POInit(POAUTOINIT=True, LINGUAS_FILE=True, POTDOMAIN='foo') +</programlisting> </listitem> </varlistentry> <varlistentry id="b-PostScript"> @@ -1731,30 +1798,35 @@ or The suffix specified by the &cv-link-PSSUFFIX; construction variable (<filename>.ps</filename> by default) is added automatically to the target -if it is not already present. Example: +if it is not already present. +&b-PostScript; is a single-source builder. +Example: </para> -<example_commands> +<programlisting language="python"> # builds from aaa.tex env.PostScript(target = 'aaa.ps', source = 'aaa.tex') # builds bbb.ps from bbb.dvi env.PostScript(target = 'bbb', source = 'bbb.dvi') -</example_commands> +</programlisting> </listitem> </varlistentry> <varlistentry id="b-POTUpdate"> <term><function>POTUpdate</function>()</term> <term><replaceable>env</replaceable>.<methodname>POTUpdate</methodname>()</term> <listitem><para> -The builder belongs to &t-link-xgettext; tool. The builder updates target -<literal>POT</literal> file if exists or creates one if it doesn't. The node is -not built by default (i.e. it is <literal>Ignore</literal>d from -<literal>'.'</literal>), but only on demand (i.e. when given -<literal>POT</literal> file is required or when special alias is invoked). This -builder adds its targe node (<filename>messages.pot</filename>, say) to a +The builder is set up by the &t-link-xgettext; tool, +part of the &t-link-gettext; toolset. +The builder updates the target +<literal>POT</literal> file if exists or creates it if it doesn't. +The target node is <emphasis>not</emphasis> +selected for building by default (e.g. <userinput>scons .</userinput>), +but only on demand (i.e. when the given +<literal>POT</literal> file is required or when special alias is invoked). +This builder adds its target node (<filename>messages.pot</filename>, say) to a special alias (<literal>pot-update</literal> by default, see &cv-link-POTUPDATE_ALIAS;) so you can update/create them easily with -<command>scons pot-update</command>. The file is not written until there is no +<userinput>scons pot-update</userinput>. The file is not written until there is no real change in internationalized messages (or in comments that enter <literal>POT</literal> file). </para> @@ -1774,86 +1846,87 @@ not.</para></note> Let's create <filename>po/</filename> directory and place following <filename>SConstruct</filename> script there: </para> -<example_commands> - # SConstruct in 'po/' subdir - env = Environment( tools = ['default', 'xgettext'] ) - env.POTUpdate(['foo'], ['../a.cpp', '../b.cpp']) - env.POTUpdate(['bar'], ['../c.cpp', '../d.cpp']) -</example_commands> +<programlisting language="python"> +# SConstruct in 'po/' subdir +env = Environment(tools=['default', 'xgettext']) +env.POTUpdate(['foo'], ['../a.cpp', '../b.cpp']) +env.POTUpdate(['bar'], ['../c.cpp', '../d.cpp']) +</programlisting> <para> Then invoke scons few times: </para> -<example_commands> - user@host:$ scons # Does not create foo.pot nor bar.pot - user@host:$ scons foo.pot # Updates or creates foo.pot - user@host:$ scons pot-update # Updates or creates foo.pot and bar.pot - user@host:$ scons -c # Does not clean foo.pot nor bar.pot. -</example_commands> +<screen> +$ scons # Does not create foo.pot nor bar.pot +$ scons foo.pot # Updates or creates foo.pot +$ scons pot-update # Updates or creates foo.pot and bar.pot +$ scons -c # Does not clean foo.pot nor bar.pot. +</screen> <para> the results shall be as the comments above say. </para> <para> <emphasis>Example 2.</emphasis> -The &b-POTUpdate; builder may be used with no target specified, in which -case default target <filename>messages.pot</filename> will be used. The -default target may also be overridden by setting &cv-link-POTDOMAIN; construction -variable or providing it as an override to &b-POTUpdate; builder: +The <parameter>target</parameter> argument can be omitted, in which +case the default target name <filename>messages.pot</filename> is used. +The target may also be overridden by setting the &cv-link-POTDOMAIN; +&consvar; or providing it as an override to the &b-POTUpdate; builder: </para> -<example_commands> - # SConstruct script - env = Environment( tools = ['default', 'xgettext'] ) - env['POTDOMAIN'] = "foo" - env.POTUpdate(source = ["a.cpp", "b.cpp"]) # Creates foo.pot ... - env.POTUpdate(POTDOMAIN = "bar", source = ["c.cpp", "d.cpp"]) # and bar.pot -</example_commands> +<programlisting language="python"> +# SConstruct script +env = Environment(tools=['default', 'xgettext']) +env['POTDOMAIN'] = "foo" +env.POTUpdate(source=["a.cpp", "b.cpp"]) # Creates foo.pot ... +env.POTUpdate(POTDOMAIN="bar", source=["c.cpp", "d.cpp"]) # and bar.pot +</programlisting> <para> <emphasis>Example 3.</emphasis> -The sources may be specified within separate file, for example +The <parameter>source</parameter> parameter may also be omitted, +if it is specified in a separate file, for example <filename>POTFILES.in</filename>: </para> -<example_commands> - # POTFILES.in in 'po/' subdirectory - ../a.cpp - ../b.cpp - # end of file -</example_commands> +<programlisting> +# POTFILES.in in 'po/' subdirectory +../a.cpp +../b.cpp +# end of file +</programlisting> <para> The name of the file (<filename>POTFILES.in</filename>) containing the list of sources is provided via &cv-link-XGETTEXTFROM;: </para> -<example_commands> - # SConstruct file in 'po/' subdirectory - env = Environment( tools = ['default', 'xgettext'] ) - env.POTUpdate(XGETTEXTFROM = 'POTFILES.in') -</example_commands> +<programlisting language="python"> +# SConstruct file in 'po/' subdirectory +env = Environment(tools=['default', 'xgettext']) +env.POTUpdate(XGETTEXTFROM='POTFILES.in') +</programlisting> <para> <emphasis>Example 4.</emphasis> -You may use &cv-link-XGETTEXTPATH; to define source search path. Assume, for -example, that you have files <filename>a.cpp</filename>, +You can use &cv-link-XGETTEXTPATH; to define the source search path. +Assume, for example, that you have files <filename>a.cpp</filename>, <filename>b.cpp</filename>, <filename>po/SConstruct</filename>, -<filename>po/POTFILES.in</filename>. Then your <literal>POT</literal>-related -files could look as below: +<filename>po/POTFILES.in</filename>. +Then your <literal>POT</literal>-related files could look like this: </para> -<example_commands> - # POTFILES.in in 'po/' subdirectory - a.cpp - b.cpp - # end of file -</example_commands> +<programlisting> +# POTFILES.in in 'po/' subdirectory +a.cpp +b.cpp +# end of file +</programlisting> -<example_commands> - # SConstruct file in 'po/' subdirectory - env = Environment( tools = ['default', 'xgettext'] ) - env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH='../') -</example_commands> +<programlisting language="python"> +# SConstruct file in 'po/' subdirectory +env = Environment(tools=['default', 'xgettext']) +env.POTUpdate(XGETTEXTFROM='POTFILES.in', XGETTEXTPATH='../') +</programlisting> <para> <emphasis>Example 5.</emphasis> -Multiple search directories may be defined within a list, i.e. -<literal>XGETTEXTPATH = ['dir1', 'dir2', ...]</literal>. The order in the list +Multiple search directories may be defined as a list, i.e. +<literal>XGETTEXTPATH=['dir1', 'dir2', ...]</literal>. The order in the list determines the search order of source files. The path to the first file found is used. </para> @@ -1861,44 +1934,44 @@ is used. <para> Let's create <filename>0/1/po/SConstruct</filename> script: </para> -<example_commands> - # SConstruct file in '0/1/po/' subdirectory - env = Environment( tools = ['default', 'xgettext'] ) - env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH=['../', '../../']) -</example_commands> +<programlisting language="python"> +# SConstruct file in '0/1/po/' subdirectory +env = Environment(tools=['default', 'xgettext']) +env.POTUpdate(XGETTEXTFROM='POTFILES.in', XGETTEXTPATH=['../', '../../']) +</programlisting> <para> and <filename>0/1/po/POTFILES.in</filename>: </para> -<example_commands> - # POTFILES.in in '0/1/po/' subdirectory - a.cpp - # end of file -</example_commands> +<programlisting> +# POTFILES.in in '0/1/po/' subdirectory +a.cpp +# end of file +</programlisting> <para> Write two <filename>*.cpp</filename> files, the first one is <filename>0/a.cpp</filename>: </para> -<example_commands> - /* 0/a.cpp */ - gettext("Hello from ../../a.cpp") -</example_commands> +<programlisting language="c++"> +/* 0/a.cpp */ +gettext("Hello from ../../a.cpp") +</programlisting> <para> and the second is <filename>0/1/a.cpp</filename>: </para> -<example_commands> - /* 0/1/a.cpp */ - gettext("Hello from ../a.cpp") -</example_commands> +<programlisting language="c++"> +/* 0/1/a.cpp */ +gettext("Hello from ../a.cpp") +</programlisting> <para> then run scons. You'll obtain <literal>0/1/po/messages.pot</literal> with the message <literal>"Hello from ../a.cpp"</literal>. When you reverse order in <varname>$XGETTEXTFOM</varname>, i.e. when you write SConscript as </para> -<example_commands> - # SConstruct file in '0/1/po/' subdirectory - env = Environment( tools = ['default', 'xgettext'] ) - env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH=['../../', '../']) -</example_commands> +<programlisting language="python"> +# SConstruct file in '0/1/po/' subdirectory +env = Environment(tools=['default', 'xgettext']) +env.POTUpdate(XGETTEXTFROM='POTFILES.in', XGETTEXTPATH=['../../', '../']) +</programlisting> <para> then the <filename>messages.pot</filename> will contain <literal>msgid "Hello from ../../a.cpp"</literal> line and not @@ -1911,23 +1984,29 @@ then the <filename>messages.pot</filename> will contain <term><function>POUpdate</function>()</term> <term><replaceable>env</replaceable>.<methodname>POUpdate</methodname>()</term> <listitem><para> -The builder belongs to &t-link-msgmerge; tool. The builder updates +The builder is set up by the &t-link-msgmerge; tool. +part of the &t-link-gettext; toolset. +The builder updates <literal>PO</literal> files with <command>msgmerge(1)</command>, or initializes -missing <literal>PO</literal> files as described in documentation of -&t-link-msginit; tool and &b-link-POInit; builder (see also -&cv-link-POAUTOINIT;). Note, that &b-POUpdate; <emphasis>does not add its -targets to <literal>po-create</literal> alias</emphasis> as &b-link-POInit; -does. +missing <literal>PO</literal> files as described in the documentation of the +&t-link-msginit; tool and the &b-link-POInit; builder (see also +&cv-link-POAUTOINIT;). +&b-POUpdate; is a single-source builder. +The <parameter>source</parameter> parameter +can also be omitted if &cv-link-LINGUAS_FILE; is set. </para> <para> -Target nodes defined through &b-POUpdate; are not built by default -(they're <literal>Ignore</literal>d from <literal>'.'</literal> node). Instead, -they are added automatically to special <literal>Alias</literal> +The target nodes are <emphasis>not</emphasis> +selected for building by default (e.g. <userinput>scons .</userinput>). +Instead, they are added automatically to special &f-link-Alias; (<literal>'po-update'</literal> by default). The alias name may be changed -through the &cv-link-POUPDATE_ALIAS; construction variable. You can easily -update <literal>PO</literal> files in your project by <command>scons -po-update</command>. +through the &cv-link-POUPDATE_ALIAS; &consvar;. You can easily +update <literal>PO</literal> files in your project by +<userinput>scons po-update</userinput>. +Note that &b-POUpdate; does not add its +targets to the <literal>po-create</literal> alias as &b-link-POInit; +does. </para> <para> @@ -1937,49 +2016,44 @@ Update <filename>en.po</filename> and <filename>pl.po</filename> from assuming that the later one exists or there is rule to build it (see &b-link-POTUpdate;): </para> -<example_commands> - # ... - env.POUpdate(['en','pl']) # messages.pot --> [en.po, pl.po] -</example_commands> +<programlisting language="python"> +env.POUpdate(['en','pl']) # messages.pot --> [en.po, pl.po] +</programlisting> <para> <emphasis>Example 2.</emphasis> Update <filename>en.po</filename> and <filename>pl.po</filename> from <filename>foo.pot</filename> template: </para> -<example_commands> - # ... - env.POUpdate(['en', 'pl'], ['foo']) # foo.pot --> [en.po, pl.pl] -</example_commands> +<programlisting language="python"> +env.POUpdate(['en', 'pl'], ['foo']) # foo.pot --> [en.po, pl.pl] +</programlisting> <para> <emphasis>Example 3.</emphasis> Update <filename>en.po</filename> and <filename>pl.po</filename> from <filename>foo.pot</filename> (another version): </para> -<example_commands> - # ... - env.POUpdate(['en', 'pl'], POTDOMAIN='foo') # foo.pot -- > [en.po, pl.pl] -</example_commands> +<programlisting language="python"> +env.POUpdate(['en', 'pl'], POTDOMAIN='foo') # foo.pot -- > [en.po, pl.pl] +</programlisting> <para> <emphasis>Example 4.</emphasis> Update files for languages defined in <filename>LINGUAS</filename> file. The files are updated from <filename>messages.pot</filename> template: </para> -<example_commands> - # ... - env.POUpdate(LINGUAS_FILE = 1) # needs 'LINGUAS' file -</example_commands> +<programlisting language="python"> +env.POUpdate(LINGUAS_FILE=True) # needs 'LINGUAS' file +</programlisting> <para> <emphasis>Example 5.</emphasis> Same as above, but update from <filename>foo.pot</filename> template: </para> -<example_commands> - # ... - env.POUpdate(LINGUAS_FILE = 1, source = ['foo']) -</example_commands> +<programlisting language="python"> +env.POUpdate(LINGUAS_FILE=True, source=['foo']) +</programlisting> <para> <emphasis>Example 6.</emphasis> @@ -1987,20 +2061,19 @@ Update <filename>en.po</filename> and <filename>pl.po</filename> plus files for languages defined in <filename>LINGUAS</filename> file. The files are updated from <filename>messages.pot</filename> template: </para> -<example_commands> - # produce 'en.po', 'pl.po' + files defined in 'LINGUAS': - env.POUpdate(['en', 'pl' ], LINGUAS_FILE = 1) -</example_commands> +<programlisting language="python"> +# produce 'en.po', 'pl.po' + files defined in 'LINGUAS': +env.POUpdate(['en', 'pl' ], LINGUAS_FILE=True) +</programlisting> <para> <emphasis>Example 7.</emphasis> Use &cv-link-POAUTOINIT; to automatically initialize <literal>PO</literal> file if it doesn't exist: </para> -<example_commands> - # ... - env.POUpdate(LINGUAS_FILE = 1, POAUTOINIT = 1) -</example_commands> +<programlisting language="python"> +env.POUpdate(LINGUAS_FILE=True, POAUTOINIT=True) +</programlisting> <para> <emphasis>Example 8.</emphasis> @@ -2009,13 +2082,12 @@ Update <literal>PO</literal> files for languages defined in <filename>foo.pot</filename> template. All necessary settings are pre-configured via environment. </para> -<example_commands> - # ... - env['POAUTOINIT'] = 1 - env['LINGUAS_FILE'] = 1 - env['POTDOMAIN'] = 'foo' - env.POUpdate() -</example_commands> +<programlisting language="python"> +env['POAUTOINIT'] = True +env['LINGUAS_FILE'] = True +env['POTDOMAIN'] = 'foo' +env.POUpdate() +</programlisting> </listitem> </varlistentry> @@ -2508,7 +2580,7 @@ are flattened. See also &b-link-Textfile;. </para> <para> -By default the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING; +By default, the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING; Examples: </para> @@ -2531,7 +2603,7 @@ it may be either a Python dictionary or a sequence of If it is a dictionary it is converted into a list of tuples with unspecified order, so if one key is a prefix of another key -or if one substitution could be further expanded by another subsitition, +or if one substitution could be further expanded by another substitution, it is unpredictable whether the expansion will occur. </para> @@ -2562,7 +2634,7 @@ env.Substfile('foo.in', SUBST_DICT=bad_foo) good_foo = [('$foobar', '$foobar'), ('$foo', '$foo')] env.Substfile('foo.in', SUBST_DICT=good_foo) -# UNPREDICTABLE - one substitution could be futher expanded +# UNPREDICTABLE - one substitution could be further expanded bad_bar = {'@bar@': '@soap@', '@soap@': 'lye'} env.Substfile('bar.in', SUBST_DICT=bad_bar) @@ -2654,7 +2726,7 @@ and &cv-link-TEXTFILESUFFIX; &consvars; are automatically added to the target if they are not already present. </para> <para> -By default the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING; +By default, the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING; Examples: </para> @@ -2668,7 +2740,7 @@ env.Textfile(target='bar', source=['lalala', 'tanteratei'], LINESEPARATOR='|*') # nested lists are flattened automatically env.Textfile(target='blob', source=['lalala', ['Goethe', 42, 'Schiller'], 'tanteratei']) -# files may be used as input by wraping them in File() +# files may be used as input by wrapping them in File() env.Textfile( target='concat', # concatenate files with a marker between source=[File('concat1'), File('concat2')], @@ -2705,54 +2777,56 @@ env.Textfile( <term><function>Translate</function>()</term> <term><replaceable>env</replaceable>.<methodname>Translate</methodname>()</term> <listitem><para> -This pseudo-builder belongs to &t-link-gettext; toolset. The builder extracts -internationalized messages from source files, updates <literal>POT</literal> -template (if necessary) and then updates <literal>PO</literal> translations (if -necessary). If &cv-link-POAUTOINIT; is set, missing <literal>PO</literal> files +This pseudo-Builder is part of the &t-link-gettext; toolset. +The builder extracts internationalized messages from source files, +updates the <literal>POT</literal> template (if necessary) +and then updates <literal>PO</literal> translations (if necessary). +If &cv-link-POAUTOINIT; is set, missing <literal>PO</literal> files will be automatically created (i.e. without translator person intervention). The variables &cv-link-LINGUAS_FILE; and &cv-link-POTDOMAIN; are taken into -acount too. All other construction variables used by &b-link-POTUpdate;, and +account too. All other construction variables used by &b-link-POTUpdate;, and &b-link-POUpdate; work here too. </para> <para> <emphasis>Example 1</emphasis>. The simplest way is to specify input files and output languages inline in -a SCons script when invoking &b-Translate; +a SCons script when invoking &b-Translate;: </para> -<example_commands> +<programlisting language="python"> # SConscript in 'po/' directory -env = Environment( tools = ["default", "gettext"] ) -env['POAUTOINIT'] = 1 -env.Translate(['en','pl'], ['../a.cpp','../b.cpp']) -</example_commands> +env = Environment(tools=["default", "gettext"]) +env['POAUTOINIT'] = True +env.Translate(['en', 'pl'], ['../a.cpp', '../b.cpp']) +</programlisting> <para> <emphasis>Example 2</emphasis>. -If you wish, you may also stick to conventional style known from +If you wish, you may also stick to the conventional style known from <productname>autotools</productname>, i.e. using <filename>POTFILES.in</filename> and <filename>LINGUAS</filename> files +to specify the targets and sources: </para> -<example_commands> +<programlisting language="python"> # LINGUAS en pl -#end -</example_commands> +# end +</programlisting> -<example_commands> +<programlisting> # POTFILES.in a.cpp b.cpp # end -</example_commands> +</programlisting> -<example_commands> +<programlisting language="python"> # SConscript -env = Environment( tools = ["default", "gettext"] ) -env['POAUTOINIT'] = 1 +env = Environment(tools=["default", "gettext"]) +env['POAUTOINIT'] = True env['XGETTEXTPATH'] = ['../'] -env.Translate(LINGUAS_FILE = 1, XGETTEXTFROM = 'POTFILES.in') -</example_commands> +env.Translate(LINGUAS_FILE=True, XGETTEXTFROM='POTFILES.in') +</programlisting> <para> The last approach is perhaps the recommended one. It allows easily split @@ -2765,7 +2839,7 @@ factor" synchronizing these two scripts is then the content of <filename>LINGUAS</filename> file. Note, that the updated <literal>POT</literal> and <literal>PO</literal> files are usually going to be committed back to the repository, so they must be updated within the source -directory (and not in variant directories). Additionaly, the file listing of +directory (and not in variant directories). Additionally, the file listing of <filename>po/</filename> directory contains <filename>LINGUAS</filename> file, so the source tree looks familiar to translators, and they may work with the project in their usual way. @@ -2775,7 +2849,7 @@ project in their usual way. <emphasis>Example 3</emphasis>. Let's prepare a development tree as below </para> -<example_commands> +<programlisting> project/ + SConstruct + build/ @@ -2785,52 +2859,55 @@ Let's prepare a development tree as below + SConscript.i18n + POTFILES.in + LINGUAS -</example_commands> +</programlisting> <para> -with <filename>build</filename> being variant directory. Write the top-level +with <filename>build</filename> being the variant directory. +Write the top-level <filename>SConstruct</filename> script as follows </para> -<example_commands> - # SConstruct - env = Environment( tools = ["default", "gettext"] ) - VariantDir('build', 'src', duplicate = 0) - env['POAUTOINIT'] = 1 - SConscript('src/po/SConscript.i18n', exports = 'env') - SConscript('build/po/SConscript', exports = 'env') -</example_commands> +<programlisting language="python"> +# SConstruct +env = Environment(tools=["default", "gettext"]) +VariantDir('build', 'src', duplicate=False) +env['POAUTOINIT'] = True +SConscript('src/po/SConscript.i18n', exports='env') +SConscript('build/po/SConscript', exports='env') +</programlisting> <para> the <filename>src/po/SConscript.i18n</filename> as </para> -<example_commands> - # src/po/SConscript.i18n - Import('env') - env.Translate(LINGUAS_FILE=1, XGETTEXTFROM='POTFILES.in', XGETTEXTPATH=['../']) -</example_commands> +<programlisting language="python"> +# src/po/SConscript.i18n +Import('env') +env.Translate(LINGUAS_FILE=True, XGETTEXTFROM='POTFILES.in', XGETTEXTPATH=['../']) +</programlisting> <para> and the <filename>src/po/SConscript</filename> </para> -<example_commands> - # src/po/SConscript - Import('env') - env.MOFiles(LINGUAS_FILE = 1) -</example_commands> +<programlisting language="python"> +# src/po/SConscript +Import('env') +env.MOFiles(LINGUAS_FILE=True) +</programlisting> <para> -Such setup produces <literal>POT</literal> and <literal>PO</literal> files -under source tree in <filename>src/po/</filename> and binary -<literal>MO</literal> files under variant tree in +Such a setup produces <literal>POT</literal> and <literal>PO</literal> files +under the source tree in <filename>src/po/</filename> and binary +<literal>MO</literal> files under the variant tree in <filename>build/po/</filename>. This way the <literal>POT</literal> and <literal>PO</literal> files are separated from other output files, which must not be committed back to source repositories (e.g. <literal>MO</literal> files). </para> -<para> -<note><para>In above example, the <literal>PO</literal> files are not updated, -nor created automatically when you issue <command>scons '.'</command> command. -The files must be updated (created) by hand via <command>scons -po-update</command> and then <literal>MO</literal> files can be compiled by -running <command>scons '.'</command>.</para></note> -</para> +<note><para>In the above example, +the <literal>PO</literal> files are not updated, +nor created automatically when you issue the command +<userinput>scons .</userinput>. +The files must be updated (created) by hand via +<userinput>scons po-update</userinput> +and then <literal>MO</literal> files can be compiled by +running <userinput>scons .</userinput>. +</para></note> </listitem> </varlistentry> diff --git a/doc/generated/examples/caching_ex-random_1.xml b/doc/generated/examples/caching_ex-random_1.xml index 0f0cfe1..d7e5ecc 100644 --- a/doc/generated/examples/caching_ex-random_1.xml +++ b/doc/generated/examples/caching_ex-random_1.xml @@ -1,8 +1,8 @@ <screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> -cc -o f1.o -c f1.c -cc -o f4.o -c f4.c -cc -o f5.o -c f5.c cc -o f2.o -c f2.c +cc -o f4.o -c f4.c cc -o f3.o -c f3.c +cc -o f1.o -c f1.c +cc -o f5.o -c f5.c cc -o prog f1.o f2.o f3.o f4.o f5.o </screen> diff --git a/doc/generated/examples/commandline_PackageVariable_1.xml b/doc/generated/examples/commandline_PackageVariable_1.xml index 367638f..49c6c85 100644 --- a/doc/generated/examples/commandline_PackageVariable_1.xml +++ b/doc/generated/examples/commandline_PackageVariable_1.xml @@ -3,7 +3,7 @@ cc -o foo.o -c -DPACKAGE="/opt/location" foo.c % <userinput>scons -Q PACKAGE=/usr/local/location foo.o</userinput> cc -o foo.o -c -DPACKAGE="/usr/local/location" foo.c % <userinput>scons -Q PACKAGE=yes foo.o</userinput> -cc -o foo.o -c -DPACKAGE="True" foo.c +cc -o foo.o -c -DPACKAGE="/opt/location" foo.c % <userinput>scons -Q PACKAGE=no foo.o</userinput> cc -o foo.o -c -DPACKAGE="False" foo.c </screen> diff --git a/doc/generated/examples/troubleshoot_explain1_3.xml b/doc/generated/examples/troubleshoot_explain1_3.xml index e658d89..d301ff3 100644 --- a/doc/generated/examples/troubleshoot_explain1_3.xml +++ b/doc/generated/examples/troubleshoot_explain1_3.xml @@ -2,5 +2,5 @@ cp file.in file.oout scons: warning: Cannot find target file.out after building -File "/Users/bdbaddog/devel/scons/git/as_scons/scripts/scons.py", line 97, in <module> +File "/Users/bdbaddog/devel/scons/git/users/prs/scripts/scons.py", line 97, in <module> </screen> diff --git a/doc/generated/examples/troubleshoot_taskmastertrace_1.xml b/doc/generated/examples/troubleshoot_taskmastertrace_1.xml index 5d10fea..fdc755d 100644 --- a/doc/generated/examples/troubleshoot_taskmastertrace_1.xml +++ b/doc/generated/examples/troubleshoot_taskmastertrace_1.xml @@ -1,8 +1,8 @@ <screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --taskmastertrace=- prog</userinput> -Job.NewParallel._work(): [Thread:8682049344] Gained exclusive access -Job.NewParallel._work(): [Thread:8682049344] Starting search -Job.NewParallel._work(): [Thread:8682049344] Found 0 completed tasks to process -Job.NewParallel._work(): [Thread:8682049344] Searching for new tasks +Job.NewParallel._work(): [Thread:8445988672] Gained exclusive access +Job.NewParallel._work(): [Thread:8445988672] Starting search +Job.NewParallel._work(): [Thread:8445988672] Found 0 completed tasks to process +Job.NewParallel._work(): [Thread:8445988672] Searching for new tasks Taskmaster: Looking for a node to evaluate Taskmaster: Considering node <no_state 0 'prog'> and its children: @@ -18,12 +18,12 @@ Taskmaster: Evaluating <pending 0 'prog.c'> Task.make_ready_current(): node <pending 0 'prog.c'> Task.prepare(): node <up_to_date 0 'prog.c'> -Job.NewParallel._work(): [Thread:8682049344] Found internal task +Job.NewParallel._work(): [Thread:8445988672] Found internal task Task.executed_with_callbacks(): node <up_to_date 0 'prog.c'> Task.postprocess(): node <up_to_date 0 'prog.c'> Task.postprocess(): removing <up_to_date 0 'prog.c'> Task.postprocess(): adjusted parent ref count <pending 1 'prog.o'> -Job.NewParallel._work(): [Thread:8682049344] Searching for new tasks +Job.NewParallel._work(): [Thread:8445988672] Searching for new tasks Taskmaster: Looking for a node to evaluate Taskmaster: Considering node <no_state 0 'inc.h'> and its children: @@ -31,12 +31,12 @@ Taskmaster: Evaluating <pending 0 'inc.h'> Task.make_ready_current(): node <pending 0 'inc.h'> Task.prepare(): node <up_to_date 0 'inc.h'> -Job.NewParallel._work(): [Thread:8682049344] Found internal task +Job.NewParallel._work(): [Thread:8445988672] Found internal task Task.executed_with_callbacks(): node <up_to_date 0 'inc.h'> Task.postprocess(): node <up_to_date 0 'inc.h'> Task.postprocess(): removing <up_to_date 0 'inc.h'> Task.postprocess(): adjusted parent ref count <pending 0 'prog.o'> -Job.NewParallel._work(): [Thread:8682049344] Searching for new tasks +Job.NewParallel._work(): [Thread:8445988672] Searching for new tasks Taskmaster: Looking for a node to evaluate Taskmaster: Considering node <pending 0 'prog.o'> and its children: @@ -46,19 +46,19 @@ Taskmaster: Evaluating <pending 0 'prog.o'> Task.make_ready_current(): node <pending 0 'prog.o'> Task.prepare(): node <executing 0 'prog.o'> -Job.NewParallel._work(): [Thread:8682049344] Found task requiring execution -Job.NewParallel._work(): [Thread:8682049344] Executing task +Job.NewParallel._work(): [Thread:8445988672] Found task requiring execution +Job.NewParallel._work(): [Thread:8445988672] Executing task Task.execute(): node <executing 0 'prog.o'> cc -o prog.o -c -I. prog.c -Job.NewParallel._work(): [Thread:8682049344] Enqueueing executed task results -Job.NewParallel._work(): [Thread:8682049344] Gained exclusive access -Job.NewParallel._work(): [Thread:8682049344] Starting search -Job.NewParallel._work(): [Thread:8682049344] Found 1 completed tasks to process +Job.NewParallel._work(): [Thread:8445988672] Enqueueing executed task results +Job.NewParallel._work(): [Thread:8445988672] Gained exclusive access +Job.NewParallel._work(): [Thread:8445988672] Starting search +Job.NewParallel._work(): [Thread:8445988672] Found 1 completed tasks to process Task.executed_with_callbacks(): node <executing 0 'prog.o'> Task.postprocess(): node <executed 0 'prog.o'> Task.postprocess(): removing <executed 0 'prog.o'> Task.postprocess(): adjusted parent ref count <pending 0 'prog'> -Job.NewParallel._work(): [Thread:8682049344] Searching for new tasks +Job.NewParallel._work(): [Thread:8445988672] Searching for new tasks Taskmaster: Looking for a node to evaluate Taskmaster: Considering node <pending 0 'prog'> and its children: @@ -67,21 +67,21 @@ Taskmaster: Evaluating <pending 0 'prog'> Task.make_ready_current(): node <pending 0 'prog'> Task.prepare(): node <executing 0 'prog'> -Job.NewParallel._work(): [Thread:8682049344] Found task requiring execution -Job.NewParallel._work(): [Thread:8682049344] Executing task +Job.NewParallel._work(): [Thread:8445988672] Found task requiring execution +Job.NewParallel._work(): [Thread:8445988672] Executing task Task.execute(): node <executing 0 'prog'> cc -o prog prog.o -Job.NewParallel._work(): [Thread:8682049344] Enqueueing executed task results -Job.NewParallel._work(): [Thread:8682049344] Gained exclusive access -Job.NewParallel._work(): [Thread:8682049344] Starting search -Job.NewParallel._work(): [Thread:8682049344] Found 1 completed tasks to process +Job.NewParallel._work(): [Thread:8445988672] Enqueueing executed task results +Job.NewParallel._work(): [Thread:8445988672] Gained exclusive access +Job.NewParallel._work(): [Thread:8445988672] Starting search +Job.NewParallel._work(): [Thread:8445988672] Found 1 completed tasks to process Task.executed_with_callbacks(): node <executing 0 'prog'> Task.postprocess(): node <executed 0 'prog'> -Job.NewParallel._work(): [Thread:8682049344] Searching for new tasks +Job.NewParallel._work(): [Thread:8445988672] Searching for new tasks Taskmaster: Looking for a node to evaluate Taskmaster: No candidate anymore. -Job.NewParallel._work(): [Thread:8682049344] Found no task requiring execution, and have no jobs: marking complete -Job.NewParallel._work(): [Thread:8682049344] Gained exclusive access -Job.NewParallel._work(): [Thread:8682049344] Completion detected, breaking from main loop +Job.NewParallel._work(): [Thread:8445988672] Found no task requiring execution, and have no jobs: marking complete +Job.NewParallel._work(): [Thread:8445988672] Gained exclusive access +Job.NewParallel._work(): [Thread:8445988672] Completion detected, breaking from main loop </screen> diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen index 8563d66..9668af8 100644 --- a/doc/generated/functions.gen +++ b/doc/generated/functions.gen @@ -26,13 +26,12 @@ for a complete explanation of the arguments and behavior. <para> Note that the &f-env-Action; form of the invocation will expand -construction variables in any argument strings, +&consvars; in any argument strings, including the <parameter>action</parameter> argument, at the time it is called -using the construction variables in the -<replaceable>env</replaceable> -construction environment through which +using the &consvars; in the +&consenv; through which &f-env-Action; was called. The &f-Action; global function form delays all variable expansion @@ -98,7 +97,7 @@ but with a few additional capabilities noted below. See the <ulink url="https://docs.python.org/3/library/optparse.html"> optparse documentation</ulink> -for a thorough discussion of its option-processing capabities. +for a thorough discussion of its option-processing capabilities. All options added through &f-AddOption; are placed in a special "Local Options" option group. </para> @@ -440,7 +439,7 @@ Example: AllowSubstExceptions() # Also allow a string containing a zero-division expansion -# like '${1 / 0}' to evalute to ''. +# like '${1 / 0}' to evaluate to ''. AllowSubstExceptions(IndexError, NameError, ZeroDivisionError) </example_commands> </listitem> @@ -451,7 +450,7 @@ AllowSubstExceptions(IndexError, NameError, ZeroDivisionError) <listitem><para> Marks each given <parameter>target</parameter> -so that it is always assumed to be out of date, +so that it is always assumed to be out-of-date, and will always be rebuilt if needed. Note, however, that &f-AlwaysBuild; @@ -506,15 +505,15 @@ named <parameter>key</parameter>, then <parameter>key</parameter> is simply stored with a value of <parameter>val</parameter>. Otherwise, <parameter>val</parameter> is -combinined with the existing value, +combined with the existing value, possibly converting into an appropriate type which can hold the expanded contents. There are a few special cases to be aware of. Normally, when two strings are combined, the result is a new string containing their concatenation (and you are responsible for supplying any needed separation); -however, the contents of &cv-link-CPPDEFINES; will -will be postprocessed by adding a prefix and/or suffix +however, the contents of &cv-link-CPPDEFINES; +will be post-processed by adding a prefix and/or suffix to each entry when the command line is produced, so &SCons; keeps them separate - appending a string will result in a separate string entry, @@ -630,7 +629,7 @@ scons: `.' is up to date. <para> <emphasis>Changed in version 4.5</emphasis>: -clarifined the use of tuples vs. other types, +clarified the use of tuples vs. other types, handling is now consistent across the four functions. </para> @@ -657,7 +656,7 @@ See &cv-link-CPPDEFINES; for more details. <para> Appending a string <parameter>val</parameter> -to a dictonary-typed &consvar; enters +to a dictionary-typed &consvar; enters <parameter>val</parameter> as the key in the dictionary, and <literal>None</literal> as its value. Using a tuple type to supply a key-value pair @@ -784,14 +783,14 @@ for a complete explanation of the arguments and behavior. Note that the <function>env.Builder</function>() form of the invocation will expand -construction variables in any arguments strings, +&consvars; in any arguments strings, including the <parameter>action</parameter> argument, at the time it is called -using the construction variables in the +using the &consvars; in the <varname>env</varname> -construction environment through which +&consenv; through which &f-env-Builder; was called. The &f-Builder; @@ -822,12 +821,12 @@ disables derived file caching. Calling the environment method &f-link-env-CacheDir; limits the effect to targets built -through the specified construction environment. +through the specified &consenv;. Calling the global function &f-link-CacheDir; sets a global default that will be used by all targets built -through construction environments +through &consenvs; that do not set up environment-specific caching by calling &f-env-CacheDir;. </para> @@ -950,7 +949,7 @@ either as separate arguments to the &f-Clean; method, or as a list. &f-Clean; -will also accept the return value of any of the construction environment +will also accept the return value of the &consenv; Builder methods. Examples: </para> @@ -982,7 +981,7 @@ Clean(['foo', 'bar'], 'something_else_to_clean') In this example, installing the project creates a subdirectory for the documentation. This statement causes the subdirectory to be removed -if the project is deinstalled. +if the project is uninstalled. </para> <example_commands> Clean(docdir, os.path.join(docdir, projectname)) @@ -1207,8 +1206,8 @@ for a complete explanation of the arguments and behavior. <varlistentry id="f-DebugOptions"> <term><function>DebugOptions</function>(<parameter>[json]</parameter>)</term> <listitem><para> -Allows setting options for SCons debug options. Currently the only supported value is - <emphasis>json</emphasis> which sets the path to the json file created when +Allows setting options for SCons debug options. Currently, the only supported value is + <emphasis>json</emphasis> which sets the path to the JSON file created when <literal>--debug=json</literal> is set. </para> <example_commands> @@ -1222,13 +1221,11 @@ DebugOptions(json='#/build/output/scons_stats.json') <term><replaceable>env</replaceable>.<methodname>Decider</methodname>(<parameter>function</parameter>)</term> <listitem><para> Specifies that all up-to-date decisions for -targets built through this construction environment -will be handled by the specified -<parameter>function</parameter>. +targets built through this &consenv; +will be handled by <parameter>function</parameter>. <parameter>function</parameter> can be the name of a function or one of the following strings -that specify the predefined decision function -that will be applied: +that specify a predefined decider function: </para> <para> @@ -1237,7 +1234,7 @@ that will be applied: <term><literal>"content"</literal></term> <listitem> <para> -Specifies that a target shall be considered out of date and rebuilt +Specifies that a target shall be considered out-of-date and rebuilt if the dependency's content has changed since the last time the target was built, as determined by performing a checksum @@ -1259,7 +1256,7 @@ can still be used as a synonym, but is deprecated. <term><literal>"content-timestamp"</literal></term> <listitem> <para> -Specifies that a target shall be considered out of date and rebuilt +Specifies that a target shall be considered out-of-date and rebuilt if the dependency's content has changed since the last time the target was built, except that dependencies with a timestamp that matches @@ -1296,7 +1293,7 @@ can still be used as a synonym, but is deprecated. <term><literal>"timestamp-newer"</literal></term> <listitem> <para> -Specifies that a target shall be considered out of date and rebuilt +Specifies that a target shall be considered out-of-date and rebuilt if the dependency's timestamp is newer than the target file's timestamp. This is the behavior of the classic Make utility, and @@ -1310,7 +1307,7 @@ can be used a synonym for <term><literal>"timestamp-match"</literal></term> <listitem> <para> -Specifies that a target shall be considered out of date and rebuilt +Specifies that a target shall be considered out-of-date and rebuilt if the dependency's timestamp is different than the timestamp recorded the last time the target was built. This provides behavior very similar to the classic Make utility @@ -1335,7 +1332,7 @@ Examples: Decider('timestamp-match') # Use hash content signatures for any targets built -# with the attached construction environment. +# with the attached &consenv;. env.Decider('content') </example_commands> @@ -1356,7 +1353,7 @@ The Node (file) which should cause the <parameter>target</parameter> to be rebuilt -if it has "changed" since the last tme +if it has "changed" since the last time <parameter>target</parameter> was built. </para> @@ -1431,7 +1428,7 @@ otherwise <emphasis>not</emphasis> be rebuilt). Note that the decision can be made -using whatever criteria are appopriate. +using whatever criteria are appropriate. Ignoring some or all of the function arguments is perfectly normal. </para> @@ -1538,7 +1535,7 @@ build phase begins, if has not already been done. However, calling it explicitly provides the opportunity to affect and examine its contents. Instantiation occurs even if nothing in the build system -appars to use it, due to internal uses. +appears to use it, due to internal uses. </para> <para> @@ -1617,14 +1614,20 @@ but will not include any such extension in the return value. </listitem> </varlistentry> <varlistentry id="f-Dictionary"> - <term><replaceable>env</replaceable>.<methodname>Dictionary</methodname>(<parameter>[vars]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Dictionary</methodname>(<parameter>[var, ...], [as_dict=]</parameter>)</term> <listitem><para> -Returns a dictionary object -containing the &consvars; in the &consenv;. -If there are any arguments specified, -the values of the specified &consvars; -are returned as a string (if one -argument) or as a list of strings. +Return an object containing &consvars; from +<parameter>env</parameter>. +If <parameter>var</parameter> is omitted, +all the &consvars; with their values +are returned in a <type>dict</type>. +If <parameter>var</parameter> is specified, +and <parameter>as_dict</parameter> is true, +the specified &consvars; are returned in a <type>dict</type>; +otherwise (the default, for backwards compatibility), +values only are returned, +as a scalar if one <parameter>var</parameter> is given, +or as a list if multiples. </para> <para> @@ -1639,8 +1642,8 @@ cc_values = env.Dictionary('CC', 'CCFLAGS', 'CCCOM') <note><para> The object returned by &f-link-env-Dictionary; should be treated as a read-only view into the &consvars;. -Some &consvars; have special internal handling, -and making changes through the &f-env-Dictionary; object can bypass +Some &consvars; require special internal handling, +and modifying them through the &f-env-Dictionary; object can bypass that handling and cause data inconsistencies. The primary use of &f-env-Dictionary; is for diagnostic purposes - it is used widely by test cases specifically because @@ -1648,6 +1651,11 @@ it bypasses the special handling so that behavior can be verified. </para></note> +<para> +<emphasis>Changed in NEXT_RELEASE</emphasis>: +<parameter>as_dict</parameter> added. +</para> + </listitem> </varlistentry> <varlistentry id="f-Dir"> @@ -1688,22 +1696,28 @@ for more information. </listitem> </varlistentry> <varlistentry id="f-Dump"> - <term><replaceable>env</replaceable>.<methodname>Dump</methodname>(<parameter>[key, ...], [format=]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Dump</methodname>(<parameter>[var, ...], [format=TYPE]</parameter>)</term> <listitem><para> -Serializes &consvars; from the current &consenv; -to a string. -The method supports the following formats specified by -<parameter>format</parameter>, -which must be used a a keyword argument: +Serialize &consvars; from <parameter>env</parameter> to a string. +If <varname>var</varname> is omitted, +all the &consvars; are serialized. +If one or more <varname>var</varname> values are supplied, +only those variables and their values are serialized. +</para> + +<para> +The optional <parameter>format</parameter> string +selects the serialization format: </para> <variablelist> <varlistentry> <term><literal>pretty</literal></term> <listitem> <para> -Returns a pretty-printed representation of the variables +Returns a pretty-printed representation +of the &consvars; - the result will look like a +&Python; <type>dict</type> (this is the default). -The variables will be presented in &Python; dict form. </para> </listitem> </varlistentry> @@ -1711,31 +1725,25 @@ The variables will be presented in &Python; dict form. <term><literal>json</literal></term> <listitem> <para> -Returns a JSON-formatted string representation of the variables. +Returns a JSON-formatted representation of the variables. The variables will be presented as a JSON object literal, -the JSON equivalent of a &Python; dict. +the JSON equivalent of a &Python; <type>dict</type>.. </para> </listitem> </varlistentry> </variablelist> <para> -If no <varname>key</varname> is supplied, -all the &consvars; are serialized. -If one or more keys are supplied, -only those keys and their values are serialized. -</para> - -<para> -<emphasis>Changed in NEXT_VERSION</emphasis>: +<emphasis>Changed in NEXT_RELEASE</emphasis>: More than one <parameter>key</parameter> can be specified. -The returned string always looks like a dict (or JSON equivalent); +The returned string always looks like a <type>dict</type> +(or equivalent in other formats); previously a single key serialized only the value, not the key with the value. </para> <para> -This SConstruct: +Examples: this &SConstruct; </para> <example_commands> @@ -1757,7 +1765,7 @@ will print something like: </example_commands> <para> -While this SConstruct: +While this &SConstruct;: </para> <example_commands> @@ -2184,7 +2192,7 @@ FindSourceFiles('src') </example_commands> <para> -As you can see build support files (SConstruct in the above example) +As you can see, build support files (&SConstruct; in the above example) will also be returned by this function. </para> </listitem> @@ -2656,8 +2664,8 @@ or (most commonly) relative to the directory of the current &f-Glob; matches both files stored on disk and Nodes which &SCons; already knows about, even if any corresponding file is not currently stored on disk. -The evironment method form (&f-env-Glob;) -performs string substition on +The environment method form (&f-env-Glob;) +performs string substitution on <parameter>pattern</parameter> and returns whatever matches the resulting expanded pattern. The results are sorted, unlike for the similar &Python; @@ -2748,7 +2756,7 @@ If the optional <parameter>source</parameter> argument evaluates true, and the local directory is a variant directory, -then &f-Glob; returnes Nodes from +then &f-Glob; returns Nodes from the corresponding source directory, rather than the local directory. <!-- XXX what about generated files that don't exist in src but will be sources? --> @@ -2782,7 +2790,7 @@ directory.) The optional <parameter>exclude</parameter> argument may be set to a pattern or a list of patterns -descibing files or directories +describing files or directories to filter out of the match list. Elements matching a least one specified pattern will be excluded. These patterns use the same syntax as for @@ -2927,7 +2935,7 @@ Import("*") The specified <parameter>string</parameter> will be preserved as-is -and not have construction variables expanded. +and not have &consvars; expanded. </para> </listitem> </varlistentry> @@ -2976,7 +2984,7 @@ In case of duplication, any &consvar; names that end in <literal>PATH</literal> keep the left-most value so the -path searcb order is not altered. +path search order is not altered. All other &consvars; keep the right-most value. If <literal>unique</literal> is false, @@ -3026,7 +3034,7 @@ either as separate arguments to the &f-NoCache; method, or as a list. &f-NoCache; -will also accept the return value of any of the construction environment +will also accept the return value of any of the &consenv; Builder methods. </para> @@ -3074,7 +3082,7 @@ either as separate arguments to the &f-NoClean; method, or as a list. &f-NoClean; -will also accept the return value of any of the construction environment +will also accept the return value of any of the &consenv; Builder methods. </para> @@ -3115,7 +3123,7 @@ is omitted or <constant>None</constant>, &f-link-env-MergeFlags; is used. By default, duplicate values are not -added to any construction variables; +added to any &consvars;; you can specify <parameter>unique=False</parameter> to allow duplicate values to be added. @@ -3138,11 +3146,11 @@ the output produced by <parameter>command</parameter> in order to distribute it to appropriate &consvars;. &f-env-MergeFlags; uses a separate function to do that processing - -see &f-link-env-ParseFlags; for the details, including a -a table of options and corresponding construction variables. +see &f-link-env-ParseFlags; for the details, including +a table of options and corresponding &consvars;. To provide alternative processing of the output of <parameter>command</parameter>, -you can suppply a custom +you can supply a custom <parameter>function</parameter>, which must accept three arguments: the &consenv; to modify, @@ -3215,12 +3223,12 @@ function. Parses one or more strings containing typical command-line flags for GCC-style tool chains and returns a dictionary with the flag values -separated into the appropriate SCons construction variables. +separated into the appropriate SCons &consvars;. Intended as a companion to the &f-link-env-MergeFlags; method, but allows for the values in the returned dictionary to be modified, if necessary, -before merging them into the construction environment. +before merging them into the &consenv;. (Note that &f-env-MergeFlags; will call this method if its argument is not a dictionary, @@ -3249,7 +3257,7 @@ See &f-link-ParseConfig; for more details. <para> Flag values are translated according to the prefix found, -and added to the following construction variables: +and added to the following &consvars;: </para> <example_commands> @@ -3289,8 +3297,7 @@ and added to the following construction variables: Any other strings not associated with options are assumed to be the names of libraries and added to the -&cv-LIBS; -construction variable. +&cv-LIBS; &consvar;. </para> <para> @@ -3315,7 +3322,7 @@ selected by <parameter>plat</parameter> (defaults to the detected platform for the current system) that can be used to initialize -a construction environment by passing it as the +a &consenv; by passing it as the <parameter>platform</parameter> keyword argument to the &f-link-Environment; function. </para> @@ -3361,7 +3368,7 @@ Returns a list of the affected target nodes. <term><replaceable>env</replaceable>.<methodname>Prepend</methodname>(<parameter>key=val, [...]</parameter>)</term> <listitem><para> Prepend values to &consvars; in the current &consenv;, -Works like &f-link-env-Append; (see for details), +works like &f-link-env-Append; (see for details), except that values are added to the front, rather than the end, of any existing value of the &consvar; </para> @@ -3566,7 +3573,7 @@ If the string contains the verbatim substring it will be replaced with the Node. Note that, for performance reasons, this is <emphasis>not</emphasis> -a regular SCons variable substition, +a regular SCons variable substitution, so you can not use other variables or use curly braces. The following example will print the name of @@ -3666,7 +3673,7 @@ env = Environment( <varlistentry id="f-Replace"> <term><replaceable>env</replaceable>.<methodname>Replace</methodname>(<parameter>key=val, [...]</parameter>)</term> <listitem><para> -Replaces construction variables in the Environment +Replaces &consvars; in the Environment with the specified keyword arguments. </para> @@ -3683,50 +3690,43 @@ env.Replace(CCFLAGS='-g', FOO='foo.xxx') <term><function>Repository</function>(<parameter>directory</parameter>)</term> <term><replaceable>env</replaceable>.<methodname>Repository</methodname>(<parameter>directory</parameter>)</term> <listitem><para> -Specifies that +Sets <parameter>directory</parameter> -is a repository to be searched for files. +as a repository to be searched for files contributing to the build. Multiple calls to &f-Repository; -are legal, -and each one adds to the list of -repositories that will be searched. +are allowed, +with repositories searched in the given order. +Repositories specified via command-line option +have higher priority. </para> <para> -To +In &scons;, -a repository is a copy of the source tree, -from the top-level directory on down, -which may contain -both source files and derived files +a repository is partial or complete copy of the source tree, +from the top-level directory down, +containing source files that can be used to build targets in -the local source tree. -The canonical example would be an -official source tree maintained by an integrator. -If the repository contains derived files, -then the derived files should have been built using -&scons;, -so that the repository contains the necessary -signature information to allow -&scons; -to figure out when it is appropriate to -use the repository copy of a derived file, -instead of building one locally. +the current worktree. +Repositories can also contain derived files. +An example might be an official source tree maintained by an integrator. +If a repository contains derived files, +they should be the result of building with &SCons;, +so a signature database (sconsign) is present +in the repository, +allowing better decisions on whether they are +up-to-date or not. </para> <para> Note that if an up-to-date derived file already exists in a repository, -&scons; -will +&scons; will <emphasis>not</emphasis> make a copy in the local directory tree. -In order to guarantee that a local copy -will be made, -use the -&f-link-Local; -method. +If you need a local copy to be made, +use the &f-link-Local; method. </para> </listitem> </varlistentry> @@ -3769,7 +3769,7 @@ env.Requires('foo', 'file-that-must-be-built-before-foo') Return to the calling SConscript, optionally returning the values of variables named in <varname>vars</varname>. -Multiple strings contaning variable names may be passed to +Multiple strings containing variable names may be passed to &f-Return;. A string containing white space is split into individual variable names. Returns the value if one variable is specified, @@ -4174,7 +4174,7 @@ in a separate <filename>.sconsign</filename> file in each directory, not in a single combined database file. -This is a backwards-compatibility meaure to support +This is a backwards-compatibility measure to support what was the default behavior prior to &SCons; 0.97 (i.e. before 2008). Use of this mode is discouraged and may be @@ -4212,7 +4212,7 @@ SConsignFile(dbm_module=dbm.gnu) <varlistentry id="f-SetDefault"> <term><replaceable>env</replaceable>.<methodname>SetDefault</methodname>(<parameter>key=val, [...]</parameter>)</term> <listitem><para> -Sets construction variables to default values specified with the keyword +Sets &consvars; to default values specified with the keyword arguments if (and only if) the variables are not already set. The following statements are equivalent: </para> @@ -4836,7 +4836,7 @@ Returns a Node object representing the specified &Python; Value Nodes can be used as dependencies of targets. If the string representation of the Value Node changes between &SCons; runs, it is considered -out of date and any targets depending it will be rebuilt. +out-of-date and any targets depending on it will be rebuilt. Since Value Nodes have no filesystem representation, timestamps are not used; the timestamp deciders perform the same content-based up to date check. diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen index b2b1583..60fdf4b 100644 --- a/doc/generated/tools.gen +++ b/doc/generated/tools.gen @@ -465,33 +465,33 @@ Sets construction variables for the D language compiler GDC. <varlistentry id="t-gettext"> <term>gettext</term> <listitem><para> -This is actually a toolset, which supports internationalization and -localization of software being constructed with SCons. The toolset loads -following tools: +A toolset supporting internationalization and +localization of software being constructed with &SCons;. +The toolset loads the following tools: </para> <para> <itemizedlist mark="opencircle"> <listitem><para> - &t-link-xgettext; - to extract internationalized messages from source code to - <literal>POT</literal> file(s), + &t-link-xgettext; - extract internationalized messages from source code to + <literal>POT</literal> file(s). </para></listitem> <listitem><para> - &t-link-msginit; - may be optionally used to initialize <literal>PO</literal> - files, + &t-link-msginit; - initialize <literal>PO</literal> + files during initial translation of a project. </para></listitem> <listitem><para> - &t-link-msgmerge; - to update <literal>PO</literal> files, that already contain + &t-link-msgmerge; - update <literal>PO</literal> files that already contain translated messages,</para></listitem> <listitem><para> - &t-link-msgfmt; - to compile textual <literal>PO</literal> file to binary - installable <literal>MO</literal> file. + &t-link-msgfmt; - compile textual <literal>PO</literal> files to binary + installable <literal>MO</literal> files. </para></listitem> </itemizedlist> </para> <para> -When you enable &t-gettext;, it internally loads all abovementioned tools, +When you enable &t-gettext;, it internally loads all the above-mentioned tools, so you're encouraged to see their individual documentation. </para> @@ -503,12 +503,12 @@ may be however interested in <emphasis>top-level</emphasis> </para> <para> -To use &t-gettext; tools add <literal>'gettext'</literal> tool to your -environment: +To use the &t-gettext; tools, add the <literal>'gettext'</literal> tool to your +&consenv;: </para> -<example_commands> - env = Environment( tools = ['default', 'gettext'] ) -</example_commands> +<programlisting language="python"> +env = Environment(tools=['default', 'gettext']) +</programlisting> </listitem> </varlistentry> <varlistentry id="t-gfortran"> @@ -529,7 +529,7 @@ Set construction variables for GNU linker/loader. <varlistentry id="t-gs"> <term>gs</term> <listitem><para> -This Tool sets the required construction variables for working with +This &f-Tool; sets the required construction variables for working with the Ghostscript software. It also registers an appropriate Action with the &b-link-PDF; Builder, such that the conversion from PS/EPS to PDF happens automatically for the TeX/LaTeX toolchain. @@ -665,7 +665,7 @@ Sets construction variables for the D language compiler LDC2. <varlistentry id="t-lex"> <term>lex</term> <listitem><para> -Sets construction variables for the &lex; lexical analyser. +Sets construction variables for the &lex; lexical analyzer. </para> <para>Sets: &cv-link-LEX;, &cv-link-LEXCOM;, &cv-link-LEXFLAGS;, &cv-link-LEXUNISTD;.</para><para>Uses: &cv-link-LEXCOMSTR;, &cv-link-LEXFLAGS;, &cv-link-LEX_HEADER_FILE;, &cv-link-LEX_TABLES_FILE;.</para></listitem> </varlistentry> @@ -718,28 +718,35 @@ Sets construction variables for MinGW (Minimal Gnu on Windows). <varlistentry id="t-msgfmt"> <term>msgfmt</term> <listitem><para> -This scons tool is a part of scons &t-link-gettext; toolset. It provides scons -interface to <command>msgfmt(1)</command> command, which generates binary -message catalog (<literal>MO</literal>) from a textual translation description -(<literal>PO</literal>). +This tool is a part of the &t-link-gettext; toolset. +It provides &SCons; +an interface to the <command>msgfmt(1)</command> command +by setting up the &b-link-MOFiles; builder, +which generates binary message catalog (<literal>MO</literal>) files +from a textual translation description +(<literal>PO</literal> files). </para> <para>Sets: &cv-link-MOSUFFIX;, &cv-link-MSGFMT;, &cv-link-MSGFMTCOM;, &cv-link-MSGFMTCOMSTR;, &cv-link-MSGFMTFLAGS;, &cv-link-POSUFFIX;.</para><para>Uses: &cv-link-LINGUAS_FILE;.</para></listitem> </varlistentry> <varlistentry id="t-msginit"> <term>msginit</term> <listitem><para> -This scons tool is a part of scons &t-link-gettext; toolset. It provides -scons interface to <command>msginit(1)</command> program, which creates new +This tool is a part of scons &t-link-gettext; toolset. It provides +&SCons; an interface to the <command>msginit(1)</command> program, +by setting up the &b-link-POInit; builder, +which creates a new <literal>PO</literal> file, initializing the meta information with values from -user's environment (or options). +the &consenv; (or options). </para> <para>Sets: &cv-link-MSGINIT;, &cv-link-MSGINITCOM;, &cv-link-MSGINITCOMSTR;, &cv-link-MSGINITFLAGS;, &cv-link-POAUTOINIT;, &cv-link-POCREATE_ALIAS;, &cv-link-POSUFFIX;, &cv-link-POTSUFFIX;, &cv-link-_MSGINITLOCALE;.</para><para>Uses: &cv-link-LINGUAS_FILE;, &cv-link-POAUTOINIT;, &cv-link-POTDOMAIN;.</para></listitem> </varlistentry> <varlistentry id="t-msgmerge"> <term>msgmerge</term> <listitem><para> -This scons tool is a part of scons &t-link-gettext; toolset. It provides -scons interface to <command>msgmerge(1)</command> command, which merges two +This tool is a part of scons &t-link-gettext; toolset. It provides +&SCons; an interface to the <command>msgmerge(1)</command> command, +by setting up the &b-link-POUpdate; builder, +which merges two Uniform style <filename>.po</filename> files together. </para> <para>Sets: &cv-link-MSGMERGE;, &cv-link-MSGMERGECOM;, &cv-link-MSGMERGECOMSTR;, &cv-link-MSGMERGEFLAGS;, &cv-link-POSUFFIX;, &cv-link-POTSUFFIX;, &cv-link-POUPDATE_ALIAS;.</para><para>Uses: &cv-link-LINGUAS_FILE;, &cv-link-POAUTOINIT;, &cv-link-POTDOMAIN;.</para></listitem> @@ -921,7 +928,7 @@ The &t-qt3; tool supports the following operations: <emphasis role="strong">Automatic moc file generation from header files.</emphasis> You do not have to specify moc files explicitly, the tool does it for you. However, there are a few preconditions to do so: Your header file must have -the same filebase as your implementation file and must stay in the same +the same basename as your implementation file and must stay in the same directory. It must have one of the suffixes <filename>.h</filename>, <filename>.hpp</filename>, @@ -1085,18 +1092,18 @@ Set &consvars; for the &b-link-Textfile; and &b-link-Substfile; builders. <varlistentry id="t-tlib"> <term>tlib</term> <listitem><para> -Sets construction variables for the Borlan -<application>tib</application> library archiver. +Sets construction variables for the Borland +<application>tlib</application> library archiver. </para> <para>Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.</para><para>Uses: &cv-link-ARCOMSTR;.</para></listitem> </varlistentry> <varlistentry id="t-xgettext"> <term>xgettext</term> <listitem><para> -This scons tool is a part of scons &t-link-gettext; toolset. It provides -scons interface to <command>xgettext(1)</command> -program, which extracts internationalized messages from source code. The tool -provides &b-POTUpdate; builder to make <literal>PO</literal> +This tool is a part of the &t-link-gettext; toolset. It provides +&SCons; an interface to the <command>xgettext(1)</command> +program, which extracts internationalized messages from source code. +The tool sets up the &b-POTUpdate; builder to make <literal>PO</literal> <emphasis>Template</emphasis> files. </para> <para>Sets: &cv-link-POTSUFFIX;, &cv-link-POTUPDATE_ALIAS;, &cv-link-XGETTEXTCOM;, &cv-link-XGETTEXTCOMSTR;, &cv-link-XGETTEXTFLAGS;, &cv-link-XGETTEXTFROM;, &cv-link-XGETTEXTFROMPREFIX;, &cv-link-XGETTEXTFROMSUFFIX;, &cv-link-XGETTEXTPATH;, &cv-link-XGETTEXTPATHPREFIX;, &cv-link-XGETTEXTPATHSUFFIX;, &cv-link-_XGETTEXTDOMAIN;, &cv-link-_XGETTEXTFROMFLAGS;, &cv-link-_XGETTEXTPATHFLAGS;.</para><para>Uses: &cv-link-POTDOMAIN;.</para></listitem> diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen index 26371cf..8383f2c 100644 --- a/doc/generated/variables.gen +++ b/doc/generated/variables.gen @@ -18,7 +18,7 @@ </term> <listitem><para> This construction variable automatically introduces &cv-link-_LDMODULEVERSIONFLAGS; -if &cv-link-LDMODULEVERSION; is set. Othervise it evaluates to an empty string. +if &cv-link-LDMODULEVERSION; is set. Otherwise, it evaluates to an empty string. </para> </listitem> </varlistentry> @@ -28,7 +28,7 @@ if &cv-link-LDMODULEVERSION; is set. Othervise it evaluates to an empty string. </term> <listitem><para> This construction variable automatically introduces &cv-link-_SHLIBVERSIONFLAGS; -if &cv-link-SHLIBVERSION; is set. Othervise it evaluates to an empty string. +if &cv-link-SHLIBVERSION; is set. Otherwise, it evaluates to an empty string. </para> </listitem> </varlistentry> @@ -560,7 +560,7 @@ after the SCons template for the file has been written. </term> <listitem><para> A reserved variable name -that may not be set or used in a construction environment. +that may not be set or used in a &consenv;. (See the manpage section "Variable Substitution" for more information). </para> @@ -572,7 +572,7 @@ for more information). </term> <listitem><para> A reserved variable name -that may not be set or used in a construction environment. +that may not be set or used in a &consenv;. (See the manpage section "Variable Substitution" for more information). </para> @@ -763,7 +763,7 @@ and the second is the macro definition. If the definition is not omitted or <literal>None</literal>, the name and definition are combined into a single <literal>name=definition</literal> item -before the preending/appending. +before the prepending/appending. </para> <example_commands> @@ -912,7 +912,7 @@ to each directory in &cv-link-CPPPATH;. The list of directories that the C preprocessor will search for include directories. The C/C++ implicit dependency scanner will search these directories for include files. -In general it's not advised to put include directory directives +In general, it's not advised to put include directory directives directly into &cv-link-CCFLAGS; or &cv-link-CXXFLAGS; as the result will be non-portable and the directories will not be searched by the dependency scanner. @@ -927,7 +927,7 @@ directory names in &cv-CPPPATH; will be looked-up relative to the directory of the SConscript file when they are used in a command. To force &scons; -to look-up a directory relative to the root of the source tree use +to lookup a directory relative to the root of the source tree, use the <literal>#</literal> prefix: </para> @@ -936,7 +936,7 @@ env = Environment(CPPPATH='#/include') </example_commands> <para> -The directory look-up can also be forced using the +The directory lookup can also be forced using the &f-link-Dir; function: </para> @@ -990,7 +990,7 @@ The default list is: </term> <listitem><para> The C++ compiler. -See also &cv-link-SHCXX; for compiling to shared objects.. +See also &cv-link-SHCXX; for compiling to shared objects. </para> </listitem> </varlistentry> @@ -1003,7 +1003,7 @@ The command line used to compile a C++ source file to an object file. Any options specified in the &cv-link-CXXFLAGS; and &cv-link-CPPFLAGS; construction variables are included on this command line. -See also &cv-link-SHCXXCOM; for compiling to shared objects.. +See also &cv-link-SHCXXCOM; for compiling to shared objects. </para> </listitem> </varlistentry> @@ -1015,7 +1015,7 @@ See also &cv-link-SHCXXCOM; for compiling to shared objects.. If set, the string displayed when a C++ source file is compiled to a (static) object file. If not set, then &cv-link-CXXCOM; (the command line) is displayed. -See also &cv-link-SHCXXCOMSTR; for compiling to shared objects.. +See also &cv-link-SHCXXCOMSTR; for compiling to shared objects. </para> <example_commands> @@ -1042,7 +1042,7 @@ and as C++ files, and files with <filename>.mm</filename> -suffixes as Objective C++ files. +suffixes as Objective-C++ files. On case-sensitive systems (Linux, UNIX, and other POSIX-alikes), SCons also treats <filename>.C</filename> @@ -1061,7 +1061,7 @@ By default, this includes the value of &cv-link-CCFLAGS;, so that setting &cv-CCFLAGS; affects both C and C++ compilation. If you want to add C++-specific flags, you must set or override the value of &cv-link-CXXFLAGS;. -See also &cv-link-SHCXXFLAGS; for compiling to shared objects.. +See also &cv-link-SHCXXFLAGS; for compiling to shared objects. </para> </listitem> </varlistentry> @@ -1509,7 +1509,7 @@ The string displayed when a renderer like <literal>fop</literal> or <envar>DOCBOOK_FOPFLAGS</envar> </term> <listitem><para> -Additonal command-line flags for the +Additional command-line flags for the PDF renderer <literal>fop</literal> or <literal>xep</literal>. </para> </listitem> @@ -1551,7 +1551,7 @@ XIncludes for a given XML file. <envar>DOCBOOK_XMLLINTFLAGS</envar> </term> <listitem><para> -Additonal command-line flags for the external executable +Additional command-line flags for the external executable <literal>xmllint</literal>. </para> </listitem> @@ -1595,7 +1595,7 @@ an XML file via a given XSLT stylesheet. <envar>DOCBOOK_XSLTPROCFLAGS</envar> </term> <listitem><para> -Additonal command-line flags for the external executable +Additional command-line flags for the external executable <literal>xsltproc</literal> (or <literal>saxon</literal>, <literal>xalan</literal>). </para> @@ -1606,7 +1606,7 @@ Additonal command-line flags for the external executable <envar>DOCBOOK_XSLTPROCPARAMS</envar> </term> <listitem><para> -Additonal parameters that are not intended for the XSLT processor executable, but +Additional parameters that are not intended for the XSLT processor executable, but the XSL processing itself. By default, they get appended at the end of the command line for <literal>saxon</literal> and <literal>saxon-xslt</literal>, respectively. </para> @@ -1907,7 +1907,7 @@ and the directories will not be searched by the dependency scanner. Note: directory names in &cv-link-F03PATH; will be looked-up relative to the SConscript directory when they are used in a command. To force &scons; -to look-up a directory relative to the root of the source tree use #: +to lookup a directory relative to the root of the source tree, use #: You only need to set &cv-link-F03PATH; if you need to define a specific include path for Fortran 03 files. You should normally set the &cv-link-FORTRANPATH; variable, @@ -1921,7 +1921,7 @@ env = Environment(F03PATH='#/include') </example_commands> <para> -The directory look-up can also be forced using the +The directory lookup can also be forced using the &Dir;() function: </para> @@ -2095,7 +2095,7 @@ and the directories will not be searched by the dependency scanner. Note: directory names in &cv-link-F08PATH; will be looked-up relative to the SConscript directory when they are used in a command. To force &scons; -to look-up a directory relative to the root of the source tree use #: +to lookup a directory relative to the root of the source tree, use #: You only need to set &cv-link-F08PATH; if you need to define a specific include path for Fortran 08 files. You should normally set the &cv-link-FORTRANPATH; variable, @@ -2109,7 +2109,7 @@ env = Environment(F08PATH='#/include') </example_commands> <para> -The directory look-up can also be forced using the +The directory lookup can also be forced using the &Dir;() function: </para> @@ -2283,7 +2283,7 @@ and the directories will not be searched by the dependency scanner. Note: directory names in &cv-link-F77PATH; will be looked-up relative to the SConscript directory when they are used in a command. To force &scons; -to look-up a directory relative to the root of the source tree use #: +to lookup a directory relative to the root of the source tree, use #: You only need to set &cv-link-F77PATH; if you need to define a specific include path for Fortran 77 files. You should normally set the &cv-link-FORTRANPATH; variable, @@ -2297,7 +2297,7 @@ env = Environment(F77PATH='#/include') </example_commands> <para> -The directory look-up can also be forced using the +The directory lookup can also be forced using the &Dir;() function: </para> @@ -2471,7 +2471,7 @@ and the directories will not be searched by the dependency scanner. Note: directory names in &cv-link-F90PATH; will be looked-up relative to the SConscript directory when they are used in a command. To force &scons; -to look-up a directory relative to the root of the source tree use #: +to lookup a directory relative to the root of the source tree, use #: You only need to set &cv-link-F90PATH; if you need to define a specific include path for Fortran 90 files. You should normally set the &cv-link-FORTRANPATH; variable, @@ -2485,7 +2485,7 @@ env = Environment(F90PATH='#/include') </example_commands> <para> -The directory look-up can also be forced using the +The directory lookup can also be forced using the &Dir;() function: </para> @@ -2658,7 +2658,7 @@ and the directories will not be searched by the dependency scanner. Note: directory names in &cv-link-F95PATH; will be looked-up relative to the SConscript directory when they are used in a command. To force &scons; -to look-up a directory relative to the root of the source tree use #: +to lookup a directory relative to the root of the source tree, use #: You only need to set &cv-link-F95PATH; if you need to define a specific include path for Fortran 95 files. You should normally set the &cv-link-FORTRANPATH; variable, @@ -2672,7 +2672,7 @@ env = Environment(F95PATH='#/include') </example_commands> <para> -The directory look-up can also be forced using the +The directory lookup can also be forced using the &Dir;() function: </para> @@ -2962,7 +2962,7 @@ non-portable and the directories will not be searched by the dependency scanner. Note: directory names in FORTRANPATH will be looked-up relative to the SConscript directory when they are used in a command. To force &scons; -to look-up a directory relative to the root of the source tree use #: +to lookup a directory relative to the root of the source tree, use #: </para> <example_commands> @@ -3365,9 +3365,9 @@ greater than one, as that has a different meaning). <para> Action strings can be segmented by the use of an AND operator, <literal>&&</literal>. -In a segemented string, each segment is a separate +In a segmented string, each segment is a separate <quote>command line</quote>, these are run -sequentially until one fails or the entire +sequentially until one fails, or the entire sequence has been executed. If an action string is segmented, then the selected behavior of &cv-IMPLICIT_COMMAND_DEPENDENCIES; @@ -3559,7 +3559,7 @@ env = Environment(JARCOMSTR="JARchiving $SOURCES into $TARGET") </term> <listitem><para> General options passed to the Java archive tool. -By default this is set to +By default, this is set to <option>cf</option> to create the necessary <command>jar</command> @@ -3881,7 +3881,7 @@ for Java classes. that &SCons; expects will be generated by the &javac; compiler. Setting &cv-JAVAVERSION; to a version greater than <literal>1.4</literal> makes &SCons; realize that a build - with such a compiler is actually up to date. + with such a compiler is actually up-to-date. The default is <literal>1.4</literal>. </para> <para> @@ -4196,7 +4196,7 @@ by &SCons; in all situations. Consider using <envar>LEXUNISTD</envar> </term> <listitem><para> -Used only on windows environments to set a lex flag to prevent 'unistd.h' from being included. The default value is '--nounistd'. +Used only in Windows environments to set a lex flag to prevent 'unistd.h' from being included. The default value is '--nounistd'. </para> </listitem> </varlistentry> @@ -4362,7 +4362,7 @@ directory names in &cv-LIBPATH; will be looked-up relative to the directory of the SConscript file when they are used in a command. To force &scons; -to look-up a directory relative to the root of the source tree use +to lookup a directory relative to the root of the source tree, use the <literal>#</literal> prefix: </para> @@ -4371,7 +4371,7 @@ env = Environment(LIBPATH='#/libs') </example_commands> <para> -The directory look-up can also be forced using the +The directory lookup can also be forced using the &f-link-Dir; function: </para> @@ -4461,7 +4461,7 @@ If &cv-link-LIBLITERALPREFIX; is set to a non-empty string, then a string-valued &cv-LIBS; entry that starts with &cv-link-LIBLITERALPREFIX; will cause the rest of the entry -to be searched for for unmodified, +to be searched for unmodified, but respecting normal library search paths (this is an exception to the guideline above about leaving off the prefix/suffix from the library name). @@ -4492,12 +4492,12 @@ env.Append(LIBS=File('/tmp/mylib.so')) <!-- is this actually true? --> For each &Builder; call that causes linking with libraries, &SCons; will add the libraries in the setting of &cv-LIBS; -in effect at that moment to the dependecy graph +in effect at that moment to the dependency graph as dependencies of the target being generated. </para> <para> -The library list will transformed to command line +The library list will be transformed to command-line arguments through the automatically-generated &cv-link-_LIBFLAGS; &consvar; which is constructed by @@ -4581,10 +4581,10 @@ It defaults to the current system line separator. The &cv-LINGUAS_FILE; defines file(s) containing list of additional linguas to be processed by &b-link-POInit;, &b-link-POUpdate; or &b-link-MOFiles; builders. It also affects &b-link-Translate; builder. If the variable contains -a string, it defines name of the list file. The &cv-LINGUAS_FILE; may be a +a string, it defines the name of the list file. The &cv-LINGUAS_FILE; may be a list of file names as well. If &cv-LINGUAS_FILE; is set to -<literal>True</literal> (or non-zero numeric value), the list will be read from -default file named +a non-string truthy value, the list will be read from +the file named <filename>LINGUAS</filename>. </para> @@ -4852,7 +4852,7 @@ See &t-link-msgfmt; tool and &b-link-MOFiles; builder. </term> <listitem><para> Path to <command>msginit(1)</command> program (found via -<literal>Detect()</literal>). +&f-link-Detect;). See &t-link-msginit; tool and &b-link-POInit; builder. </para> </listitem> @@ -4872,8 +4872,9 @@ See &t-link-msginit; tool and &b-link-POInit; builder. <envar>MSGINITCOMSTR</envar> </term> <listitem><para> -String to display when <command>msginit(1)</command> is invoked -(default: <literal>''</literal>, which means ``print &cv-link-MSGINITCOM;''). +String to display when <command>msginit(1)</command> is invoked. +The default is an empty string, +which will print the command line (&cv-link-MSGINITCOM;). See &t-link-msginit; tool and &b-link-POInit; builder. </para> </listitem> @@ -4928,8 +4929,9 @@ See &t-link-msgmerge; tool and &b-link-POUpdate; builder. <envar>MSGMERGECOMSTR</envar> </term> <listitem><para> -String to be displayed when <command>msgmerge(1)</command> is invoked -(default: <literal>''</literal>, which means ``print &cv-link-MSGMERGECOM;''). +String to be displayed when <command>msgmerge(1)</command> is invoked. +The default is an empty string, +which will print the command line (&cv-link-MSGMERGECOM;). See &t-link-msgmerge; tool and &b-link-POUpdate; builder. </para> </listitem> @@ -6206,7 +6208,7 @@ Visual Studio </literallayout></entry> It is only necessary to specify the <literal>Exp</literal> suffix to select the express edition when both express and non-express editions of the same product are installed - simulaneously. The <literal>Exp</literal> suffix is unnecessary, + simultaneously. The <literal>Exp</literal> suffix is unnecessary, but accepted, when only the express edition is installed. </para></listitem> </itemizedlist> @@ -6368,7 +6370,7 @@ and &cv-link-MSVC_USE_SETTINGS;. <literal>SccProjectFilePathRelativizedFromConnection[i]</literal> (where [i] ranges from 0 to the number of projects in the solution) attributes of the <literal>GlobalSection(SourceCodeControl)</literal> - section of the Microsoft Visual Studio solution file. Similarly + section of the Microsoft Visual Studio solution file. Similarly, the relative solution file path is placed as the values of the <literal>SccLocalPath[i]</literal> (where [i] ranges from 0 to the number of projects in the solution) attributes of the @@ -6433,7 +6435,7 @@ and &cv-link-MSVC_USE_SETTINGS;. and &cv-MSVC_VERSION; is not, &cv-MSVC_VERSION; will be initialized to the value of &cv-MSVS_VERSION;. - An error is raised if If both are set and have different values, + An error is raised if both are set and have different values. </para> </listitem> </varlistentry> @@ -6759,7 +6761,7 @@ scons NINJA_CMD_ARGS="-v -j 3" <envar>NINJA_FORCE_SCONS_BUILD</envar> </term> <listitem><para> - If true, causes the build nodes to callback to scons instead of using + If true, causes the build nodes to call back to scons instead of using &ninja; to build them. This is intended to be passed to the environment on the builder invocation. It is useful if you have a build node which does something which is not easily translated into &ninja;. </para> @@ -6829,7 +6831,7 @@ scons NINJA_CMD_ARGS="-v -j 3" </term> <listitem><para> Internal value used to specify the function to call with argument env to generate the list of files - which if changed would require the &ninja; build file to be regenerated. + which, if changed, would require the &ninja; build file to be regenerated. </para> </listitem> </varlistentry> @@ -6838,7 +6840,7 @@ scons NINJA_CMD_ARGS="-v -j 3" <envar>NINJA_SCONS_DAEMON_KEEP_ALIVE</envar> </term> <listitem><para> - The number of seconds for the SCons deamon launched by ninja to stay alive. + The number of seconds for the SCons daemon launched by ninja to stay alive. (Default: 180000) </para> </listitem> @@ -6916,7 +6918,7 @@ placed if applicable. The default value is <quote>&cv-NAME;-&cv-VERSION;</quote </term> <listitem><para> Selects the package type to build when using the &b-link-Package; -builder. May be a string or list of strings. See the docuentation +builder. It may be a string or list of strings. See the documentation for the builder for the currently supported types. </para> @@ -7000,7 +7002,7 @@ only if the &cv-link-PDB; &consvar; is set. <listitem><para> This variable specifies how much of a source file is precompiled. This variable is ignored by tools other than &MSVC;, or when -the PCH variable is not being used. When this variable is define it +the PCH variable is not being used. When this variable is defined, it must be a string that is the name of the header that is included at the end of the precompiled portion of the source files, or the empty string if the "#pragma hrdstop" construct is being used: @@ -8294,7 +8296,7 @@ See also &cv-link-CXXFLAGS; for compiling to static objects. </term> <listitem><para> The name of the compiler to use when compiling D source -destined to be in a shared objects. +destined to be in a shared object. See also &cv-link-DC; for compiling to static objects. </para> </listitem> @@ -9006,7 +9008,7 @@ When this &consvar; is defined, a versioned shared library is created by the &b-link-SharedLibrary; builder. This activates the &cv-link-_SHLIBVERSIONFLAGS; and thus modifies the &cv-link-SHLINKCOM; as required, adds the version number to the library name, and creates the symlinks -that are needed. &cv-link-SHLIBVERSION; versions should exist as alpha-numeric, +that are needed. &cv-link-SHLIBVERSION; versions should exist as alphanumeric, decimal-delimited values as defined by the regular expression "\w+[\.\w+]*". Example &cv-link-SHLIBVERSION; values include '1', '1.2.3', and '1.2.gitaa412c8b'. </para> @@ -9146,7 +9148,7 @@ The variable is used, for example, by &t-link-gnulink; linker tool. </term> <listitem><para> A reserved variable name -that may not be set or used in a construction environment. +that may not be set or used in a &consenv;. (See the manpage section "Variable Substitution" for more information). </para> @@ -9173,7 +9175,7 @@ field in the controlling information for Ipkg and RPM packages. </term> <listitem><para> A reserved variable name -that may not be set or used in a construction environment. +that may not be set or used in a &consenv;. (See the manpage section "Variable Substitution" for more information). </para> @@ -9458,7 +9460,7 @@ will be looked-up relative to the SConscript directory when they are used in a command. To force &scons; -to look-up a directory relative to the root of the source tree use +to lookup a directory relative to the root of the source tree, use a top-relative path (<literal>#</literal>): </para> @@ -9467,7 +9469,7 @@ env = Environment(SWIGPATH='#/include') </example_commands> <para> -The directory look-up can also be forced using the +The directory lookup can also be forced using the &Dir;() function: </para> @@ -9555,7 +9557,7 @@ General options passed to the tar archiver. </term> <listitem><para> A reserved variable name -that may not be set or used in a construction environment. +that may not be set or used in a &consenv;. (See the manpage section "Variable Substitution" for more information). </para> @@ -9631,7 +9633,7 @@ for more information). </term> <listitem><para> A reserved variable name -that may not be set or used in a construction environment. +that may not be set or used in a &consenv;. (See the manpage section "Variable Substitution" for more information). </para> @@ -9885,7 +9887,7 @@ The value is informative and is not guaranteed to be complete. </term> <listitem><para> A reserved variable name -that may not be set or used in a construction environment. +that may not be set or used in a &consenv;. (See the manpage section "Variable Substitution" for more information). </para> @@ -9897,7 +9899,7 @@ for more information). </term> <listitem><para> A reserved variable name -that may not be set or used in a construction environment. +that may not be set or used in a &consenv;. (See the manpage section "Variable Substitution" for more information). </para> @@ -10362,7 +10364,7 @@ field in the RPM <envar>X_RPM_EXTRADEFS</envar> </term> <listitem><para> -A list used to supply extra defintions or flags +A list used to supply extra definitions or flags to be added to the RPM <filename>.spec</filename> file. Each item is added as-is with a carriage return appended. This is useful if some specific RPM feature not otherwise @@ -10643,7 +10645,7 @@ See &t-link-xgettext; tool and &b-link-POTUpdate; builder. <envar>_XGETTEXTFROMFLAGS</envar> </term> <listitem><para> -Internal "macro". Genrates list of <literal>-D<dir></literal> flags +Internal "macro". Generates list of <literal>-D<dir></literal> flags from the &cv-link-XGETTEXTPATH; list. </para> </listitem> @@ -10654,7 +10656,7 @@ from the &cv-link-XGETTEXTPATH; list. </term> <listitem><para> This flag is used to add single &cv-link-XGETTEXTFROM; file to -<command>xgettext(1)</command>'s commandline (default: +<command>xgettext(1)</command>'s command line (default: <literal>'-f'</literal>). </para> </listitem> @@ -10698,7 +10700,7 @@ from &cv-link-XGETTEXTFROM;. </term> <listitem><para> This flag is used to add single search path to -<command>xgettext(1)</command>'s commandline (default: +<command>xgettext(1)</command>'s command line (default: <literal>'-D'</literal>). </para> </listitem> @@ -11010,7 +11012,7 @@ General options passed to the zip utility. <listitem><para> An optional zip root directory (default empty). The filenames stored in the zip file will be relative to this directory, if given. -Otherwise the filenames are relative to the current directory of the +Otherwise, the filenames are relative to the current directory of the command. For instance: </para> |