Permalink
Browse files

Spec update: In V2, incremental Snappy is the new Snappy

In other words, non-incremental Snappy compression is no longer valid
Sereal in protocol version 2.
  • Loading branch information...
1 parent 996260b commit b67440d38e2d564bddfb650b60580b8a7ddfa4fb @tsee tsee committed May 13, 2013
Showing with 8 additions and 4 deletions.
  1. +8 −4 sereal_spec.pod
View
@@ -75,14 +75,18 @@ Raw Sereal format. The data can be processed verbatim.
=item 1
-Compressed Sereal format, using Google's Snappy compression internally.
-Prefer I<2> wherever possible.
+B<This is not a valid document type for Sereal protocol version 2!>
+
+In Sereal protocol version 1, this used to be
+"Compressed Sereal format, using Google's Snappy compression internally."
+It has long been advised to prefer I<2>, "incremental-decoding-enabled
+compressed Sereal," wherever possible.
=item 2
Compressed Sereal format, using Google's Snappy compression internally as
-format I<1>, but supporting incremental-parsing. Preferred over I<1> as this
-is considered a bug fix in the Snappy compression support.
+format I<1>, but supporting incremental-parsing. Long preferred over
+I<1> as this is considered a bug fix in the Snappy compression support.
The format is:

0 comments on commit b67440d

Please sign in to comment.