Error log providers need to be able to trigger a startup error from their

init() function.  A NULL return code is the trigger.


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

1 files changed, 4 insertions, 0 deletions

diff --git a/include/http_core.h b/include/http_core.h
index 59b584853c..2e635cffa6 100644
--- a/include/http_core.h
+++ b/include/http_core.h
@@ -856,6 +856,10 @@ struct ap_errorlog_provider {
      * @param p The pool to create any storage from
      * @param s Server for which the logger is initialized
      * @return Pointer to handle passed later to writer() function
+     * @note On success, the provider must return non-NULL, even if
+     * the handle is not necessary when the writer() function is
+     * called.  On failure, the provider should log a startup error
+     * message and return NULL to abort httpd startup.
      */
     void * (*init)(apr_pool_t *p, server_rec *s);