From: Rich Bowen <rbowen@apache.org>
Date: Wed, 23 Feb 2022 14:38:20 +0000 (+0000)
Subject: Resolves BZ65861 - clarify post_config api doc
X-Git-Tag: 2.5.0-alpha2-ci-test-only~481
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=669bdbb45bff9f9b85408d869296b00ed14e5b1e;p=thirdparty%2Fapache%2Fhttpd.git

Resolves BZ65861 - clarify post_config api doc

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

diff --git a/include/http_config.h b/include/http_config.h
index 2aac6d43253..39fe72aff8c 100644
--- a/include/http_config.h
+++ b/include/http_config.h
@@ -1350,6 +1350,16 @@ AP_DECLARE_HOOK(void,test_config,(apr_pool_t *pconf, server_rec *s))
 
 /**
  * Run the post_config function for each module
+ *
+ * The function might be called multiple times.  @a pconf, @a plog, and
+ * @a ptemp may be cleared and/or destroyed between calls.
+ *
+ * The function will be called zero or one times with the server's state being
+ * #AP_SQ_MS_CREATE_PRE_CONFIG, and will be called one or more times with
+ * the server's state being #AP_SQ_MS_CREATE_CONFIG.
+ *
+ * @see ap_state_query(), #AP_SQ_MAIN_STATE
+ *
  * @param pconf The config pool
  * @param plog The logging streams pool
  * @param ptemp The temporary pool