svn commit: r1369810 - /httpd/httpd/branches/2.4.x/include/http_log.h

[tr...@apache.org]

Author: trawick
Date: Mon Aug  6 12:16:03 2012
New Revision: 1369810

URL: http://svn.apache.org/viewvc?rev=1369810&view=rev
Log:
clarify that the 2.4 pidfile APIs process paths relative to ServerRoot

Modified:
    httpd/httpd/branches/2.4.x/include/http_log.h

Modified: httpd/httpd/branches/2.4.x/include/http_log.h
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/include/http_log.h?rev=1369810&r1=1369809&r2=1369810&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/include/http_log.h (original)
+++ httpd/httpd/branches/2.4.x/include/http_log.h Mon Aug  6 12:16:03 2012
@@ -569,21 +569,24 @@ AP_DECLARE(void) ap_log_command_line(apr
 /**
  * Log the current pid of the parent process
  * @param p The pool to use for processing
- * @param fname The name of the file to log to
+ * @param fname The name of the file to log to.  If the filename is not
+ * absolute then it is assumed to be relative to ServerRoot.
  */
 AP_DECLARE(void) ap_log_pid(apr_pool_t *p, const char *fname);
 
 /**
  * Remove the pidfile.
  * @param p The pool to use for processing
- * @param fname The name of the pid file to remove
+ * @param fname The name of the pid file to remove.  If the filename is not
+ * absolute then it is assumed to be relative to ServerRoot.
  */
 AP_DECLARE(void) ap_remove_pid(apr_pool_t *p, const char *fname);
 
 /**
  * Retrieve the pid from a pidfile.
  * @param p The pool to use for processing
- * @param filename The name of the file containing the pid
+ * @param filename The name of the file containing the pid.  If the filename is not
+ * absolute then it is assumed to be relative to ServerRoot.
  * @param mypid Pointer to pid_t (valid only if return APR_SUCCESS)
  */
 AP_DECLARE(apr_status_t) ap_read_pid(apr_pool_t *p, const char *filename, pid_t *mypid);