From: Jim Jagielski <jim@apache.org>
Date: Wed, 7 Mar 2012 12:51:04 +0000 (+0000)
Subject: Docs (and minor comment change) for DefaultRuntimeDir directive
X-Git-Tag: 2.5.0-alpha~7406
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=25c27c59ddb7242901767eb98e195fd686f85f11;p=apache

Docs (and minor comment change) for DefaultRuntimeDir directive


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1297959 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml
index 3766077a81..28e6b3324b 100644
--- a/docs/manual/mod/core.xml
+++ b/docs/manual/mod/core.xml
@@ -604,6 +604,37 @@ headers</description>
 </usage>
 </directivesynopsis>
 
+<directivesynopsis>
+<name>DefaultRuntimeDir</name>
+<description>Base directory for the server run-time files</description>
+<syntax>DefaultRuntimeDir <var>directory-path</var></syntax>
+<default>DefaultRuntimeDir DEFAULT_REL_RUNTIMEDIR (logs/)</default>
+<contextlist><context>server config</context></contextlist>
+
+<usage>
+    <p>The <directive>DefaultRuntimeDir</directive> directive sets the
+    directory in which the server will create various run-time files
+    (shared memory, locks, etc.). If set as a relative path, the full path
+    will be relative to <directive>ServerRoot</directive></p>
+
+    <example><title>Example</title>
+      DefaultRuntimeDir scratch/
+    </example>
+
+    <p>The default location of <directive>DefaultRuntimeDir</directive> may be
+    modified by changing the <code>DEFAULT_REL_RUNTIMEDIR</code> #define
+    at build time.</p>
+
+   <p>Note: <directive>ServerRoot</directive> should be specified before this
+   directive is used, otherwise the default value of <directive>ServerRoot</directive>
+   would be used to set the base directory.</p>
+
+</usage>
+<seealso><a href="../misc/security_tips.html#serverroot">the
+    security tips</a> for information on how to properly set
+    permissions on the <directive>ServerRoot</directive></seealso>
+</directivesynopsis>
+
 <directivesynopsis>
 <name>DefaultType</name>
 <description>This directive has no effect other than to emit warnings
diff --git a/include/http_config.h b/include/http_config.h
index db7feb90f7..617ab2a682 100644
--- a/include/http_config.h
+++ b/include/http_config.h
@@ -709,7 +709,7 @@ AP_DECLARE(char *) ap_server_root_relative(apr_pool_t *p, const char *fname);
 /**
  * Compute the name of a run-time file (e.g., shared memory "file") relative
  * to the appropriate run-time directory.  Absolute paths are returned as-is.
- * The run-time directory is configured via the RuntimeDir directive or
+ * The run-time directory is configured via the DefaultRuntimeDir directive or
  * at build time.
  */
 AP_DECLARE(char *) ap_runtime_dir_relative(apr_pool_t *p, const char *fname);