diff options
| author | Daniel Moody <daniel.moody@mongodb.com> | 2021-02-25 05:57:21 +0000 |
|---|---|---|
| committer | Daniel Moody <daniel.moody@mongodb.com> | 2021-04-01 16:50:41 +0000 |
| commit | 1fc91c5e7531daf60a93359f1d6d09b33a3d6c32 (patch) | |
| tree | 1210d307dece41c95b3561c09a2fa6a5c5b10668 /SCons/Environment.xml | |
| parent | 1f0349124eec626363c8a875062113494dc15acd (diff) | |
| download | scons-git-1fc91c5e7531daf60a93359f1d6d09b33a3d6c32.tar.gz | |
fix up some doc issues and add test coverage
Diffstat (limited to 'SCons/Environment.xml')
| -rw-r--r-- | SCons/Environment.xml | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/SCons/Environment.xml b/SCons/Environment.xml index 754b59f52..945ed9c01 100644 --- a/SCons/Environment.xml +++ b/SCons/Environment.xml @@ -756,7 +756,7 @@ until after the Builder object is actually called. <scons_function name="CacheDir"> <arguments> -(cache_dir, custom_class=<constant>None</constant>) +(cache_dir, custom_class=None) </arguments> <summary> <para> @@ -772,10 +772,15 @@ Specifying a of <constant>None</constant> disables derived file caching. -A custom class which is a subclass of -<classname>SCons.CacheDir.CacheDir<classname> -can be passed as the optional second parameter -allowing customization of the caching behaviors. +</para> + +<para> +When specifying a +<parameter>custom_class</parameter> which should be a class type which is a subclass of +<classname>SCons.CacheDir.CacheDir</classname>, SCons will +internally invoke this class to use for performing caching operations. +This argument is optional and if left to default <constant>None</constant>, will use the +default <classname>SCons.CacheDir.CacheDir</classname> class. </para> <para> |