svn commit: rev 96 - commons/serf/branches/gen2

[gs...@apache.org]

Author: gstein
Date: Sun Nov  9 11:58:48 2003
New Revision: 96

Modified:
   commons/serf/branches/gen2/serf.h
Log:
* gen2/serf.h:
  (SERF_NEWLINE_CRLF_SPLIT): add comment about why we have this symbol
    instead of a potentially-easier alternative.


Modified: commons/serf/branches/gen2/serf.h
==============================================================================
--- commons/serf/branches/gen2/serf.h	(original)
+++ commons/serf/branches/gen2/serf.h	Sun Nov  9 11:58:48 2003
@@ -330,6 +330,14 @@
 /** Used to indicate that a CR was found at the end of a buffer, and CRLF
  * was acceptable. It may be that the LF is present, but it needs to be
  * read first.
+ *
+ * Note: an alternative to using this symbol would be for callers to see
+ * the SERF_NEWLINE_CR return value, and know that some "end of buffer" was
+ * reached. While this works well for @see serf_util_readline, it does not
+ * necessary work as well for buckets (there is no obvious "end of buffer",
+ * although there is an "end of bucket"). The other problem with that
+ * alternative is that developers might miss the condition. This symbol
+ * calls out the possibility and ensures that callers will watch for it.
  */
 #define SERF_NEWLINE_CRLF_SPLIT 0x0010