Re: [h5md-user] Version numbers

[Peter Colberg]

Hi Konrad,

On Tue, Nov 05, 2013 at 04:03:40PM +0100, Konrad Hinsen wrote:
> I just noticed that the two modules defined in the H5MD specification
> have the version number 1.0.0. However, the main H5MD specification
> provides two integers for the version number.
> 
> The comment about semantic versioning probably provides the answer, as
> the third number is not supposed to have an impact on the file
> structure. The two numbers stored are thus the first two one. However,
> it would be better to say so explicitly if my interpretation is right.

Your interpretation is correct.

The specification of modules already contains this paragraph:

`version`
:   An attribute, of `Integer` datatype and of simple dataspace of rank 1 and
    size 2, that contains the major version number and the minor version number
    of the module.

    The version *x.y.z* of an H5MD module follows [semantic versioning]: A
    change of the major version number *x* indicates backwards-incompatible
    changes to the file structure, a change of the minor version number *y*
    indicates backwards-compatible changes to the file structure, and a change
    of the patch version number *z* indicates changes that have no effect on
    the file structure.


Is this explicit enough, or should we improve the description?

Regards,
Peter