From: Jim Jagielski <jim@apache.org>
Date: Mon, 19 Mar 2007 15:03:17 +0000 (+0000)
Subject: Note what the actually "valid" usage for apr_brigade_destroy
X-Git-Tag: 2.3.0~1875
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=29d197c94708f7a059c1d36610b06ec2d3d1509e;p=thirdparty%2Fapache%2Fhttpd.git

Note what the actually "valid" usage for apr_brigade_destroy
is, but still urge people to avoid it.


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

diff --git a/docs/manual/developer/output-filters.xml b/docs/manual/developer/output-filters.xml
index ac4cf62320e..f70ab2389a7 100644
--- a/docs/manual/developer/output-filters.xml
+++ b/docs/manual/developer/output-filters.xml
@@ -170,7 +170,9 @@
     href="#state">state structure</a>.</p>
 
     <note type="warning"><p>It is generally never advisable to use
-    <code>apr_brigade_destroy</code> to "destroy" a brigade.  The
+    <code>apr_brigade_destroy</code> to "destroy" a brigade unless
+    you know for certain that the brigade will never be used
+    again, even then, it should be used rarely.  The
     memory used by the brigade structure will not be released by
     calling this function (since it comes from a pool), but the
     associated pool cleanup is unregistered.  Using