Browse files

minor changes to the documentation

  • Loading branch information...
1 parent b5f6e03 commit d83bc5136b150838b6024cdce75e29d68e2b12fa @xant xant committed Aug 19, 2013
Showing with 4 additions and 0 deletions.
  1. +2 −0 Perl/Encoder/lib/Sereal/
  2. +2 −0 sereal_spec.pod
@@ -107,6 +107,8 @@ The size threshold (in bytes) of the uncompressed output below which
snappy compression is not even attempted even if enabled.
Defaults to one kilobyte (1024 bytes). Set to 0 and C<snappy> to enabled
to always compress.
+Note that the document will not be compressed if the resulting size
+will be bigger than the original size (even if snappy_threshold is 0).
=head3 croak_on_bless
@@ -396,6 +396,8 @@ In Sereal protocol version 2, offsets were changed from being relative to
the start of the document (including header) to being relative to the start
of the document body (ie. excluding the document header). This means that
Sereal document bodies are now self-contained - relocatable within the document.
+Note that the offset is 1-based, which means that to point the first byte
+of the body its value must be 1.
Additionally, protocol version 2 introduced the 8bit bit-field (8bit-BITFIELD)
in the variable-length/optional header part (OPT-SUFFIX) of the document

0 comments on commit d83bc51

Please sign in to comment.