* util_filter.h (ap_filter_flush): clarify that this function has

    nothing to do with FLUSH buckets. It is simply a cover function
    for ap_pass_brigade for use with the apr_brigade_* writing
    functions.

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

diff --git a/include/util_filter.h b/include/util_filter.h
index a4ba30bf3e992a458b9090d45fb0273e74c2e14c..ff2baf77b45c18194621a4cfabaddc5e7015f78f 100644 (file)
--- a/include/util_filter.h
+++ b/include/util_filter.h
@@ -479,6 +479,8 @@ AP_DECLARE(apr_status_t) ap_save_brigade(ap_filter_t *f,
  * to flush the brigade if the brigade buffer overflows.
  * @param bb The brigade to flush
  * @param ctx The filter to pass the brigade to
+ * @note this function has nothing to do with FLUSH buckets. It is simply
+ * a way to flush content out of a brigade and down a filter stack.
  */
 AP_DECLARE_NONSTD(apr_status_t) ap_filter_flush(apr_bucket_brigade *bb,
                                                 void *ctx);