cereal icon indicating copy to clipboard operation
cereal copied to clipboard

Please advertise your lack of commitment to being "a robust long term storage solution" on your front page

Open hexagonrecursion opened this issue 4 years ago • 0 comments

I was very surprised to find the following statement buried in the middle of your documentation.

cereal was not designed to be a robust long term storage solution - it is your responsibility to ensure compatability between saved and loaded cereal archives. It is recommended that you use the same version of cereal for both loading and saving data.

Looking at your change log it appears you only increment the minor version number (e.g 1.1.2 -> 1.2.0) when breaking the serialization format.

This policy is a dealbreaker for some usecases of serialization. While it does represent a valid point in design space that possibly allows you to better support other usecases it should:

  1. Be stated more precisely. For example: are 1.2.0 and 1.2.1 the same version?
  2. Be advertised on the front page instead of being buried on a page some users might skip. This will save you and users you don't intend to support a lot of grief.

hexagonrecursion avatar Jun 14 '20 20:06 hexagonrecursion