From 36473165f81ffd18e18d4dbdb9a1e366e9c7092f Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Mon, 26 Sep 2022 08:57:19 -0600 Subject: Modernize SCONS_CACHE_MSVC_CONFIG manpage entry [skip appveyor] Mention name change; remove the wording about version changes possibly causing problems - the currrent implementation should be resilient to this. Signed-off-by: Mats Wichmann --- doc/man/scons.xml | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 19dbb76..e00db3d 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -8398,29 +8398,29 @@ so the command line can be used to override (Windows only). If set, save the shell environment variables generated when setting up the Microsoft Visual C++ compiler -(and/or Build Tools) to a cache file, to give these settings, -which are relatively expensive to generate, persistence -across &scons; invocations. -Use of this option is primarily intended to aid performance -in tightly controlled Continuous Integration setups. +(and/or Build Tools) to a cache file, to give these settings +persistence across &scons; invocations. +Generating this information is relatively expensive, +so using this option may aid performance where &scons; is run often, +such as Continuous Integration setups. If set to a True-like value ("1", "true" or "True") will cache to a file named -.scons_msvc_cache.json in the user's home directory. +scons_msvc_cache.json in the user's home directory. If set to a pathname, will use that pathname for the cache. -Note: use this cache with caution as it -might be somewhat fragile: while each major toolset version -(e.g. Visual Studio 2017 vs 2019) and architecture pair will get separate -cache entries, if toolset updates cause a change -to settings within a given release series, &scons; will not -detect the change and will reuse old settings. -Remove the cache file in case of problems with this. -&scons; will ignore failures reading or writing the file -and will silently revert to non-cached behavior in such cases. - -Available since &scons; 3.1 (experimental). +Note: this implementation may still be somewhat fragile. +In case of problems, remove the cache file - recreating with +fresh info normally resolves any issues. +&SCons; ignores failures reading or writing the cache file +and will silently revert to non-cached behavior in such cases. + + +New in 3.1 (experimental). +The default cache file name was changed to +its present value in 4.4, and contents were expanded. + -- cgit v0.12