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 ac4cf62320ebf64cadd3aa74165a4fcbe82f6532..f70ab2389a7b41986012b422b09f01ee2ae3177a 100644 (file)
--- 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