find_prorgram_path() can now add discovered path

Many tools contain a stanza like this, usually for the Windows case,
where installed programs are rarely added to the "standard" path
in SCons' execution environment (i.e. env['ENV']["PATH']):

    javac = SCons.Tool.find_program_path(env, 'javac', default_paths=paths)
    if javac:
        javac_bin_dir = os.path.dirname(javac)
        env.AppendENVPath('PATH', javac_bin_dir)

This change adds a keyword argument add_path to find_program_path() to
instruct it to add the path a program was discovered in, if it was in the
extra paths passed in. The default is False, retaining the existing behavior.

Signed-off-by: Mats Wichmann <mats@linux.com>

1 files changed, 4 insertions, 0 deletions

diff --git a/CHANGES.txt b/CHANGES.txt
index ee1139a..a9006a5 100755
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -184,6 +184,10 @@ RELEASE  VERSION/DATE TO BE FILLED IN LATER
       that link has been modified (issue #3880)
     - Modernize a few tests that use now-deprecated unittest.getTestCaseNames
       and unittest.makeSuite - Python itself suggests the replacements.
+    - SCons.Tool.find_program_path now takes an optional add_path argument
+      to add a path to the execution environment if it was discovered in
+      default_paths. Previously, the routine, called by many tool modules,
+      never altered the execution environment, leaving it to the tools.
 
   From Zhichang Yu:
     - Added MSVC_USE_SCRIPT_ARGS variable to pass arguments to MSVC_USE_SCRIPT.