Clarified comment on arg constraints for ap_get_brigade()

Submitted by:	Joe Schaefer <joe+gmane@sunstarsys.com>
Reviewed by:	Brian Pane

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

diff --git a/include/util_filter.h b/include/util_filter.h
index fb75f37b9ea3f9f97ea164210a1b1ab60a025320..a4ba30bf3e992a458b9090d45fb0273e74c2e14c 100644 (file)
--- a/include/util_filter.h
+++ b/include/util_filter.h
@@ -298,7 +298,8 @@ struct ap_filter_t {
  * filter doesn't read from the network, then ::AP_NOBODY_READ is returned.
  * The bucket brigade will be empty when there is nothing left to get.
  * @param filter The next filter in the chain
- * @param bucket The current bucket brigade
+ * @param bucket The current bucket brigade.  The original brigade passed
+ *               to ap_get_brigade() must be empty.
  * @param mode   The way in which the data should be read
  * @param block  How the operations should be performed
  *               ::APR_BLOCK_READ, ::APR_NONBLOCK_READ