From: Jeff Trawick <trawick@apache.org>
Date: Fri, 18 Mar 2011 14:21:01 +0000 (+0000)
Subject: describe the ap_log_error(...,ap_server_conf,...) idiom
X-Git-Tag: 2.3.12~207
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ecfdf9d9e3fe7556d7b313dcacbd5400afc7cf8f;p=thirdparty%2Fapache%2Fhttpd.git

describe the ap_log_error(...,ap_server_conf,...) idiom


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

diff --git a/docs/manual/developer/new_api_2_4.xml b/docs/manual/developer/new_api_2_4.xml
index 7a5feccd011..15e98d84c06 100644
--- a/docs/manual/developer/new_api_2_4.xml
+++ b/docs/manual/developer/new_api_2_4.xml
@@ -286,6 +286,18 @@
        <code>ap_log_*</code> without additional wrappers. In this way, the
        code will remain compatible with HTTPD 2.0 and 2.2.</p>
 
+    <p>A <code>server_rec</code> pointer must be passed to 
+       <code>ap_log_error()</code> when called after startup.  This
+       was always appropriate, but there are even more limitations with
+       a <code>NULL</code> <code>server_rec</code> in 2.4 than in
+       previous releases.  Beginning with 2.3.12, the global variable
+       <code>ap_server_conf</code> can always be used as
+       the <code>server_rec</code> parameter, as it will be
+       <code>NULL</code> only when it is valid to pass <code>NULL</code>
+       to <code>ap_log_error()</code>.  <code>ap_server_conf</code>
+       should be used only when a more appropriate <code>server_rec</code>
+       is not available.</p> 
+
     <p>Consider the following changes to take advantage of the new
        <code>APLOG_TRACE1..8</code> log levels:</p>
        <ul>