You are viewing a plain text version of this content. The canonical link for it is here.
Posted to user@avro.apache.org by Lewis John Mcgibbney <le...@gmail.com> on 2014/09/28 06:20:37 UTC

Adding Conclusion to Avro Spec

Hi Folks,
I've read, and try to re-read the spec documentation whenever there is a
new release of Avro.
I always feel cut-off or at a loss when I hit the end of the document... it
just... ends!
Is there a possibility that someone can add material on how static the
specification documentation is, where people should go if they find
something wrong/require more clarification about, etc.
I think it would be a nice addition to the documentation and I would offer
to contribute this but I am pretty damn sure that I do not have enough
context to do this justice.
BTW, this is coming more from a users perspective so I hope that it is
appreciated and interpreted that way.
Thank you
Lewis

-- 
*Lewis*

Re: Adding Conclusion to Avro Spec

Posted by Lewis John Mcgibbney <le...@gmail.com>.
Hi Doug,
Thanks for reply... I understand that I am here :)
Exactly what you've included within your reply would add value to the spec
document.
If we could get that in there it would be great. This information is
utterly implicit to an outsider/new user.
Thanks
Lewis

On Monday, September 29, 2014, Doug Cutting <cu...@apache.org> wrote:

> On Sat, Sep 27, 2014 at 9:20 PM, Lewis John Mcgibbney
> <lewis.mcgibbney@gmail.com <javascript:;>> wrote:
> > Is there a possibility that someone can add material on how static the
> > specification documentation is
>
> Minor versions are meant to have back-compatible APIs and both back-
> and forward-compatible data formats.  Since the specification
> primarily concerns data formats, it's pretty stable.  In particular,
> every schema since 1.0 can be parsed by every 1.x release and every
> datum serialized since 1.0 should be readable by every 1.x release.
> We broke this policy once, in 1.3, which incompatibly altered the Avro
> file format.  I doubt we'll break it again.  Any further changes to
> forward or backward data compatibility would require a 2.0 release.
>
> > where people should go if they find
> > something wrong/require more clarification about, etc.
>
> You're there!
>
> This information could be included in the specification.  My instinct
> is to add it at the start, rather than the end, but I don't feel too
> strongly about that.
>
> Doug
>


-- 
*Lewis*

Re: Adding Conclusion to Avro Spec

Posted by Doug Cutting <cu...@apache.org>.
On Sat, Sep 27, 2014 at 9:20 PM, Lewis John Mcgibbney
<le...@gmail.com> wrote:
> Is there a possibility that someone can add material on how static the
> specification documentation is

Minor versions are meant to have back-compatible APIs and both back-
and forward-compatible data formats.  Since the specification
primarily concerns data formats, it's pretty stable.  In particular,
every schema since 1.0 can be parsed by every 1.x release and every
datum serialized since 1.0 should be readable by every 1.x release.
We broke this policy once, in 1.3, which incompatibly altered the Avro
file format.  I doubt we'll break it again.  Any further changes to
forward or backward data compatibility would require a 2.0 release.

> where people should go if they find
> something wrong/require more clarification about, etc.

You're there!

This information could be included in the specification.  My instinct
is to add it at the start, rather than the end, but I don't feel too
strongly about that.

Doug