You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@httpd.apache.org by Aaron Bannert <aa...@clove.org> on 2001/10/08 18:19:40 UTC

[PATCH] fix some misleading/incorrect verbage in filter headers

In trying to learn how filters work, I came across some verbage in the
headers that should probably be changed:

- ap_get_brigade() reads, it doesn't write (I think).
- it doesn't make sense to say a filter "should" return a status, so I
  changed it to say it simply will return a status.

-aaron


Index: include/util_filter.h
===================================================================
RCS file: /home/cvspublic/httpd-2.0/include/util_filter.h,v
retrieving revision 1.59
diff -u -r1.59 util_filter.h
--- include/util_filter.h	2001/09/11 18:38:21	1.59
+++ include/util_filter.h	2001/10/08 16:09:38
@@ -268,8 +268,8 @@
 
 /**
  * Get the current bucket brigade from the next filter on the filter
- * stack.  The filter should return an apr_status_t value.  If the bottom-most 
- * filter doesn't write to the network, then ::AP_NOBODY_READ is returned.
+ * stack.  The filter returns an apr_status_t value.  If the bottom-most 
+ * filter doesn't read from the network, then ::AP_NOBODY_READ is returned.
  * @param filter The next filter in the chain
  * @param bucket The current bucket brigade
  * @param mode   ::AP_MODE_BLOCKING, ::AP_MODE_NONBLOCKING, or ::AP_MODE_PEEK
@@ -281,7 +281,7 @@
 
 /**
  * Pass the current bucket brigade down to the next filter on the filter
- * stack.  The filter should return an apr_status_t value.  If the bottom-most 
+ * stack.  The filter returns an apr_status_t value.  If the bottom-most 
  * filter doesn't write to the network, then ::AP_NOBODY_WROTE is returned.
  * @param filter The next filter in the chain
  * @param bucket The current bucket brigade

Re: [PATCH] fix some misleading/incorrect verbage in filter headers

Posted by Ian Holsman <ia...@apache.org>.
On Mon, 08 Oct 2001 09:29:54 -0700, Aaron Bannert wrote:

> In trying to learn how filters work, I came across some verbage in the
> headers that should probably be changed:
> 
> - ap_get_brigade() reads, it doesn't write (I think). - it doesn't make
> sense to say a filter "should" return a status, so I
>   changed it to say it simply will return a status.
> 
done.
Thanks

> -aaron
> 
> 
> Index: include/util_filter.h
> =================================================================== RCS
> file: /home/cvspublic/httpd-2.0/include/util_filter.h,v retrieving
> revision 1.59
> diff -u -r1.59 util_filter.h
> --- include/util_filter.h	2001/09/11 18:38:21	1.59 +++
> include/util_filter.h	2001/10/08 16:09:38 @@ -268,8 +268,8 @@
>  
>  /**
>   * Get the current bucket brigade from the next filter on the filter
> - * stack.  The filter should return an apr_status_t value.  If the
> bottom-most - * filter doesn't write to the network, then
> ::AP_NOBODY_READ is returned. + * stack.  The filter returns an
> apr_status_t value.  If the bottom-most + * filter doesn't read from the
> network, then ::AP_NOBODY_READ is returned.
>   * @param filter The next filter in the chain * @param bucket The
>   current bucket brigade * @param mode   ::AP_MODE_BLOCKING,
>   ::AP_MODE_NONBLOCKING, or ::AP_MODE_PEEK
> @@ -281,7 +281,7 @@
>  
>  /**
>   * Pass the current bucket brigade down to the next filter on the
>   filter
> - * stack.  The filter should return an apr_status_t value.  If the
> bottom-most + * stack.  The filter returns an apr_status_t value.  If
> the bottom-most
>   * filter doesn't write to the network, then ::AP_NOBODY_WROTE is
>   returned. * @param filter The next filter in the chain * @param bucket
>   The current bucket brigade