summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul J. Reder <rederpj@apache.org>2002-10-24 18:56:18 +0000
committerPaul J. Reder <rederpj@apache.org>2002-10-24 18:56:18 +0000
commit4d41fa588fbc492046ca3fe62fd29b36159ae75d (patch)
tree7ff338e32c95ca9cc8b84728a831ef80b10032a7 /docs
parentccb3fa0ac746baf634a6d9e0d7f7716a0c06292c (diff)
downloadhttpd-4d41fa588fbc492046ca3fe62fd29b36159ae75d.tar.gz
Change the CacheRoot processing to check for a required
value at config time. This saves a lot of wasted processing if the mod_disk_cache module is loaded but no CacheRoot was provided. This fix also adds code to log an error and avoid useless pallocs and procesing when the computed cache file name cannot be opened. This also updates the docs accordingly. [Paul J. Reder] git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97291 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs')
-rw-r--r--docs/manual/mod/mod_disk_cache.xml15
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/manual/mod/mod_disk_cache.xml b/docs/manual/mod/mod_disk_cache.xml
index 5c415f7f51..66e7555c99 100644
--- a/docs/manual/mod/mod_disk_cache.xml
+++ b/docs/manual/mod/mod_disk_cache.xml
@@ -24,14 +24,19 @@ This module is experimental. Documentation is still under development...
<directivesynopsis>
<name>CacheRoot</name>
-<description>The directory to store cache files</description>
+<description>The directory root under which cache files are stored</description>
<syntax>CacheRoot <em>directory</em></syntax>
<default>none</default>
<contextlist><context>server config</context></contextlist>
<usage>
<p>The <directive>CacheRoot</directive> directive defines the name of the directory
- on the disk to contain cache files. What is happening if not set ?</p>
+ on the disk to contain cache files. If the mod_disk_cache module has been loaded
+ or compiled in to the Apache server, this directive <em>must</em> be defined. Failing to
+ provide a value for <directive>CacheRoot</directive> will result in a configuration
+ file processing error. The <directive>CacheDirLevels</directive> and
+ <directive>CacheDirLength</directive> directives define the structure of the directories
+ under the specified root directory.</p>
<example>
CacheRoot c:/cacheroot <br />
@@ -47,14 +52,14 @@ This module is experimental. Documentation is still under development...
<contextlist><context>server config</context></contextlist>
<usage>
- <p>The <directive>MCacheSize</directive> directive sets the desired disk space
+ <p>The <directive>CacheSize</directive> directive sets the desired disk space
usage of the cache, in KBytes (1024-byte units). This directive does not put a
hard limit on the size of the cache. The garbage collector will delete files
until the usage is at or below the settings. Always use a value that is lower
than the available disk space.</p>
<example>
- MCacheSize 5000000 <br />
+ CacheSize 5000000 <br />
</example>
</usage>
</directivesynopsis>
@@ -256,4 +261,4 @@ The <directive>CacheGcMemUsage</directive> directive is currently <em>not</em> i
</usage>
</directivesynopsis>
-</modulesynopsis> \ No newline at end of file
+</modulesynopsis>