svn commit: r1297959 - in /httpd/httpd/trunk: docs/manual/mod/core.xml include/http_config.h

[ji...@apache.org]

Author: jim
Date: Wed Mar  7 12:51:04 2012
New Revision: 1297959

URL: http://svn.apache.org/viewvc?rev=1297959&view=rev
Log:
Docs (and minor comment change) for DefaultRuntimeDir directive

Modified:
    httpd/httpd/trunk/docs/manual/mod/core.xml
    httpd/httpd/trunk/include/http_config.h

Modified: httpd/httpd/trunk/docs/manual/mod/core.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/core.xml?rev=1297959&r1=1297958&r2=1297959&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/core.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/core.xml Wed Mar  7 12:51:04 2012
@@ -605,6 +605,37 @@ headers</description>
 </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
 if the value is not <code>none</code>. In prior versions, DefaultType

Modified: httpd/httpd/trunk/include/http_config.h
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/include/http_config.h?rev=1297959&r1=1297958&r2=1297959&view=diff
==============================================================================
--- httpd/httpd/trunk/include/http_config.h (original)
+++ httpd/httpd/trunk/include/http_config.h Wed Mar  7 12:51:04 2012
@@ -709,7 +709,7 @@ AP_DECLARE(char *) ap_server_root_relati
 /**
  * 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);