Skip to content

Commit

Permalink
Minor spec fixes (cosmetics)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsee committed Sep 10, 2012
1 parent cd6119a commit 04b88e3
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions sereal_spec.pod
Expand Up @@ -36,7 +36,7 @@ last byte always having the high bit off. The data is in little endian
order with the low seven bits in the first byte, and the next 7 in the
next etc.

See L<googles description|https://developers.google.com/protocol-buffers/docs/encoding#varints>
See L<Google's description|https://developers.google.com/protocol-buffers/docs/encoding#varints>.

=back

Expand All @@ -60,7 +60,7 @@ A single byte, of which the high 4 bits are used to represent the "type"
of the document, and the low 4 bits used to represent the version of the
Sereal protocol the document complies with.

Up until now there has only been one version of sereal released so the
Up until now there has only been one version of Sereal released so the
low bits will be 1.

Currently only two types are defined:
Expand All @@ -82,9 +82,12 @@ numbers by the maintainers of the protocol.

=item HEADER-SUFFIX-SIZE

The header includes support for additional arbitrary data to be embedded
in the header. This is accomplished by specifying the length of the suffix
in the header with a varint. Headers with no suffix will set this to 0.
The structure of the header includes support for embedding additional data.
This is accomplished by specifying the length of the suffix
in the header with a varint. Headers with no suffix will set this to a
binary 0. This is intended for future format extensions that retain some
level of compatibility for old decoders (which know how to skip the
extended header due to the embedded length).

=item OPT-SUFFIX

Expand Down Expand Up @@ -340,14 +343,17 @@ Rafaël Garcia-Suarez
=head1 ACKNOWLEDGMENT

This protocol was originally developed for Booking.com. With approval
from Booking.com, this module was generalized and published on CPAN,
for which the authors would like to express their gratitude.
from Booking.com, this document was generalized and published on github
and CPAN, for which the authors would like to express their gratitude.

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2012 by Steffen Mueller

Copyright (C) 2012 by Yves Orton

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=cut

0 comments on commit 04b88e3

Please sign in to comment.