From b6acf5ee664d1d4440bc02be33d4cf0f155e349f Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Thu, 8 Dec 2022 09:10:06 -0700 Subject: Tweak no-exec manpage wording [skip appveyor] Minor change - this was one of the options where the xml id was changed, and the previous wording just didn't seem to be that smooth. Signed-off-by: Mats Wichmann --- doc/man/scons.xml | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 4d72180..8dda049 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -1611,24 +1611,29 @@ no matter how old the file is. -Set no execute mode. +Set no-exec mode. Print the commands that would be executed to build -any out-of-date target files, but do not execute the commands. - -The output is a best effort, as &SCons; cannot always precisely -determine what would be built. For example, if a file is generated -by a builder action that is later used in the build, -that file is not available to scan for dependencies on an unbuilt tree, -or may contain out of date information in a built tree. +any out-of-date targets, but do not execute those commands. + -Work which is done directly in &Python; code in &SConscript; files, -as opposed to work done by builder actions during the build phase, -will still be carried out. If it is important to avoid some -such work from taking place in no execute mode, it should be protected. -An &SConscript; file can determine which mode -is active by querying &f-link-GetOption;, as in the call -if GetOption("no_exec"): +Only target building is suppressed - any work in the build +system that is done directly (in regular &Python; code) +will still be carried out. You can add guards around +code which should not be executed in no-exec mode by +checking the value of the option at run time with &f-link-GetOption;: + + +if not GetOption("no_exec"): + # run regular instructions + + +The output is a best effort, as &SCons; cannot always precisely +determine what would be built. For example, if a file generated +by a builder action is also used as a source in the build, +that file is not available to scan for dependencies at all +in an unbuilt tree, and may contain out of date information in a +previously built tree. @@ -1682,7 +1687,7 @@ directories to the toolpath. -The type +The type of package to create when using the &b-link-Package; builder. Multiple types can be specified by using a comma-separated string, in which case &SCons; will try to build for all of those package types. -- cgit v0.12