Better document the error cases returned from get_chunk_size().

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

diff --git a/modules/http/http_protocol.c b/modules/http/http_protocol.c
index d8f18ccfc9f48a796e8d00bfca886093cb7af6ee..48082def1afa3a0198d063fd3e0536deb80d36f1 100644 (file)
--- a/modules/http/http_protocol.c
+++ b/modules/http/http_protocol.c
@@ -1763,6 +1763,15 @@ AP_DECLARE(int) ap_should_client_block(request_rec *r)
     return 1;
 }
 
+/**
+ * Parse a chunk extension, detect overflow.
+ * There are two error cases:
+ *  1) If the conversion would require too many bits, a -1 is returned.
+ *  2) If the conversion used the correct number of bits, but an overflow
+ *     caused only the sign bit to flip, then that negative number is
+ *     returned.
+ * In general, any negative number can be considered an overflow error.
+ */
 static long get_chunk_size(char *b)
 {
     long chunksize = 0;