Skip to content

Commit 6f9a9d2

Browse files
committed
manpage intro: a few more tweaks [skip appveyor]
Signed-off-by: Mats Wichmann <[email protected]>
1 parent 7ff17a5 commit 6f9a9d2

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

doc/man/scons.xml

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ need be specified in a call to a builder.
122122
For example if you specify a shared library target named "foo",
123123
&SCons; keeps track of the actual operating system dependent filename
124124
(such as <filename>libfoo.so</filename> on a GNU/Linux system
125-
and <filename>foo.dll</filename> on Windows)),
125+
and <filename>foo.dll</filename> on Windows),
126126
and gives you a handle to refer to that target in other steps,
127127
so you don't have to use system-specific strings yourself.
128128
&SCons; can also scan automatically for dependency information,
@@ -166,22 +166,23 @@ See the &f-link-VariantDir; description for more details.
166166

167167
<para>
168168
When invoked, &scons;
169-
looks for a file named
170-
&SConstruct;
171-
(other names are also accepted,
172-
see <xref linkend="sconscript_files"/>)
173-
in the current directory and reads the
174-
build configuration from that file;
175-
that directory is considered the project top directory.
169+
looks for a file describing the build configuration
170+
in the current directory and reads that in.
171+
The file is by default named &SConstruct;,
172+
although some variants of that,
173+
or a developer-chosen name, are also accepted
174+
(see <xref linkend="sconscript_files"/>).
175+
If found, the currrent directory
176+
is set as the project top directory.
176177
Certain command-line options specify alternate
177-
places to look for the &SConstruct;
178+
places to look for &SConstruct;
178179
(see
179180
<link linkend="opt-directory"><option>-C</option></link>,
180181
<link linkend="opt-D"><option>-D</option></link>,
181182
<link linkend="opt-up"><option>-u</option></link> and
182183
<link linkend="opt-U"><option>-U</option></link>),
183-
which will set the project top directory to the place found.
184-
A path to the main build configuration file can also be
184+
which will set the project top directory to the path found.
185+
A path to the build configuration can also be
185186
specified with the
186187
<link linkend="opt-f"><option>-f</option></link> option,
187188
which leaves the current directory as the project top directory.
@@ -208,13 +209,13 @@ regardless of the actual file names or number of such files.
208209
A hierarchical build is not recursive - all of
209210
the SConscript files are processed in a single pass
210211
so that &scons; has a picture of the complete
211-
dependency tree at all times.
212+
dependency tree when it begins considering what needs building.
212213
Each SConscript file is processed in a separate context
213214
so settings made in one script do not leak into another;
214215
information can however be shared explicitly between scripts.
215216
</para>
216217

217-
<para>Before reading the &SConscript; files,
218+
<para>Before reading the SConscript files,
218219
&scons;
219220
looks for a <firstterm>site directory</firstterm> -
220221
a directory named <filename>site_scons</filename>
@@ -288,7 +289,7 @@ in effect at the time &scons; was called.
288289
This helps avoid problems like picking up accidental
289290
or malicious settings,
290291
temporary debug values that are no longer needed,
291-
or one developer having different settings than another
292+
or a developer having different settings than another
292293
(or than the CI pipeline).
293294
Environment variables needed for the proper
294295
operation of such commands must be set in the

0 commit comments

Comments
 (0)