Skip to content

Commit 365ca4a

Browse files
committed
Minor manpage updates. [skip appveyor]
Consistent use of &Python; entity. Add something on Configure + variantdir. Also some docstrings. Signed-off-by: Mats Wichmann <[email protected]>
1 parent 3b168f5 commit 365ca4a

File tree

6 files changed

+154
-90
lines changed

6 files changed

+154
-90
lines changed

CHANGES.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,9 @@ RELEASE VERSION/DATE TO BE FILLED IN LATER
9999
describe the Microsoft C++ compiler. Update the version table slightly.
100100
Amplified the usage of MSVC_VERSION.
101101
- Improve SharedLibrary docs a bit.
102+
- More consistent use of &Python; in the manpage. A few links added.
103+
A warning about overwriting env['ENV'] and one about Configure
104+
checks possibly not running in in no-exec mode also added.
102105

103106

104107
RELEASE 4.6.0 - Sun, 19 Nov 2023 17:22:20 -0700

SCons/Defaults.xml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,14 @@ containing the
5757
<filename>SConstruct</filename>
5858
file.
5959
</para>
60+
<para>
61+
If variant directories are in use,
62+
and the configure check results should not be
63+
shared between variants,
64+
you can set &cv-CONFIGUREDIR;
65+
and &cv-link-CONFIGURELOG; so they are
66+
unique per variant directory.
67+
</para>
6068
</summary>
6169
</cvar>
6270

@@ -71,6 +79,14 @@ containing the
7179
<filename>SConstruct</filename>
7280
file.
7381
</para>
82+
<para>
83+
If variant directories are in use,
84+
and the configure check results should not be
85+
shared between variants,
86+
you can set &cv-link-CONFIGUREDIR;
87+
and &cv-CONFIGURELOG; so they are
88+
unique per variant directory.
89+
</para>
7490
</summary>
7591
</cvar>
7692

SCons/Environment.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -633,6 +633,17 @@ def setdefault(self, key, default=None):
633633
return self._dict.setdefault(key, default)
634634

635635
def arg2nodes(self, args, node_factory=_null, lookup_list=_null, **kw):
636+
"""Converts *args* to a list of nodes.
637+
638+
Arguments:
639+
args - filename strings or nodes to convert; nodes are just
640+
added to the list without further processing.
641+
node_factory - optional factory to create the nodes; if not
642+
specified, will use this environment's ``fs.File method.
643+
lookup_list - optional list of lookup functions to call to
644+
attempt to find the file referenced by each *args*.
645+
kw - keyword arguments that represent additional nodes to add.
646+
"""
636647
if node_factory is _null:
637648
node_factory = self.fs.File
638649
if lookup_list is _null:

SCons/Environment.xml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2999,9 +2999,9 @@ method.
29992999
<summary>
30003000
<para>
30013001
Specifies an order-only relationship
3002-
between the specified target file(s)
3003-
and the specified prerequisite file(s).
3004-
The prerequisite file(s)
3002+
between <parameter>target</parameter>
3003+
and <parameter>prerequisite</parameter>.
3004+
The prerequisites
30053005
will be (re)built, if necessary,
30063006
<emphasis>before</emphasis>
30073007
the target file(s),
@@ -3012,6 +3012,9 @@ the prerequisite file(s) change.
30123012
<parameter>target</parameter> and
30133013
<parameter>prerequisite</parameter> may each
30143014
be a string or Node, or a list of strings or Nodes.
3015+
If there are multiple
3016+
<parameter>target</parameter> values,
3017+
the prerequisite(s) are added to each one.
30153018
Returns a list of the affected target nodes.
30163019
</para>
30173020

0 commit comments

Comments
 (0)