diff --git a/CHANGES.txt b/CHANGES.txt index f05cf7cad..fe14e03a8 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -19,6 +19,7 @@ RELEASE VERSION/DATE TO BE FILLED IN LATER - Switch test framework from using profile to cProfile. profile generates deprecation warnings starting with Python 3.15. - Improve documentation of builder methods and builder objects. + - Make links clickable in the SetOption and GetOption manpage entries. RELEASE 4.10.0 - Thu, 02 Oct 2025 11:40:20 -0700 diff --git a/RELEASE.txt b/RELEASE.txt index e29657c13..0e4eb1f79 100644 --- a/RELEASE.txt +++ b/RELEASE.txt @@ -58,6 +58,8 @@ DOCUMENTATION - Improve documentation of builder methods and builder objects. +- Make links clickable in the SetOption and GetOption manpage entries. + DEVELOPMENT ----------- diff --git a/SCons/Script/Main.xml b/SCons/Script/Main.xml index 810e8aae5..747b81c60 100644 --- a/SCons/Script/Main.xml +++ b/SCons/Script/Main.xml @@ -345,9 +345,9 @@ atexit.register(print_build_failures) -Query the value of settable options which may have been set -on the command line, via option defaults, -or by using the &f-link-SetOption; function. +Query the value of settable option name, +which may have been set on the command line, via option defaults, +or using the &f-link-SetOption; function. The value of the option is returned in a type matching how the option was declared - see the documentation of the corresponding command line option for information about each specific @@ -369,7 +369,7 @@ processed prior to the &f-GetOption; call in the &SConscript; files. Query name - Command-line options + Command-line argument Notes @@ -377,46 +377,61 @@ processed prior to the &f-GetOption; call in the &SConscript; files. cache_debug - + + + + cache_disable + , + cache_force + , + cache_readonly - + + + cache_show - + + + clean + , , + climb_up - - - - + + , + , + , + , + @@ -425,162 +440,244 @@ processed prior to the &f-GetOption; call in the &SConscript; files. debug - + directory - , + + + , + + + diskcheck - + duplicate - + enable_virtualenv - + + + experimental - - since 4.2 + + + + Since 4.2. file + , , , + + + + + hash_chunksize + + + + + Replaces . Since 4.2 hash_format - - since 4.2 + + Since 4.2 help - , + + + , + + ignore_errors - , + + + , + + + ignore_virtualenv - + + + implicit_cache - + + + implicit_deps_changed - + + + implicit_deps_unchanged - + + + + + include_dir - , + + + , + + + install_sandbox - + + + Available only if the &t-link-install; tool has been called keep_going - , + + + , + + + max_drift - + md5_chunksize - , - + + + + Replaced by . + Deprecated since 4.2 - since 4.2 no_exec + , , , , + no_progress - + num_jobs - , + + , + package_type - + + + Available only if the &t-link-packaging; tool has been called profile_file - + question - , + + + , + + + random - + + + repository + , , + silent + , , + site_dir - , + + , + + stack_size - + + + taskmastertrace_file - + + + tree_printers - + warn - , + + + , + + + @@ -782,24 +879,22 @@ in many situations when defining target names that are not directly built. -Sets &scons; option variable name +Set option variable name to value. -These options are all also settable via -command-line options but the variable name -may differ from the command-line option name - -see the table for correspondences. -A value set via command-line option will take -precedence over one set with &f-SetOption;, which -allows setting a project default in the scripts and -temporarily overriding it via command line. -&f-SetOption; calls can also be placed in the +Settable options have corresponding command-line +arguments, which can be used for one-time overrides, +as a value set via command-line option will take +precedence over one set with &f-SetOption;. +The table shows the correspondence between the +option name and the command-line argument(s). +&f-SetOption; calls can also be placed in a site_init.py file. -See the documentation in the manpage for the -corresponding command line option for information about each specific option. -The value parameter is mandatory, +The behavior of the options is described in the +manpage entry for the command-line version. +The value parameter is mandatory; for option values which are boolean in nature (that is, the command line option does not take an argument) use a value @@ -821,7 +916,7 @@ added via an &f-link-AddOption; call, &f-SetOption; is available only after the &f-AddOption; call has completed successfully, and only if that call included the -settable=True argument. +settable=True keyword argument. @@ -836,7 +931,7 @@ The settable variables with their associated command-line options are: Settable name - Command-line options + Command-line argument Notes @@ -845,95 +940,134 @@ The settable variables with their associated command-line options are: clean - , - , - + + , + , + + diskcheck - + + + duplicate - + + + experimental - - since 4.2 + + + + Since 4.2. hash_chunksize - - Actually sets md5_chunksize. - since 4.2 + + + + Replaces . Since 4.2 hash_format - - since 4.2 + + + + Since 4.2 help - , + + , + + + implicit_cache - + + + implicit_deps_changed - + + + + + Also sets implicit_cache. - (settable since 4.2) + Settable since 4.2 implicit_deps_unchanged - + + + + + Also sets implicit_cache. - (settable since 4.2) + Settable since 4.2 + + max_drift - + + + md5_chunksize - + + + + + Synonym for . + Deprecated since 4.2 + no_exec - , - , - , - , - + + , + , + , + , + + no_progress - + + + See If no_progress is set via &f-SetOption; @@ -950,31 +1084,37 @@ The settable variables with their associated command-line options are: num_jobs - , + + , + random - + silent - , - , - + + , + , + + stack_size - + + + warn - + @@ -990,7 +1130,6 @@ SetOption('max_drift', 0) -