clarify that the 2.4 pidfile APIs process paths relative to ServerRoot

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1369810 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/include/http_log.h b/include/http_log.h
index 77991fca7fcb4ebe21ec4dce372ae7c78274d3a0..acad032817dd13bd5630544cfa1cb9b4d536e66c 100644 (file)
--- a/include/http_log.h
+++ b/include/http_log.h
@@ -569,21 +569,24 @@ AP_DECLARE(void) ap_log_command_line(apr_pool_t *p, server_rec *s);
 /**
  * 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);