Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert to semantic 2.0.0 versioning #4956

Open
wants to merge 8 commits into
base: feature/develop-2.0
Choose a base branch
from
Open

Convert to semantic 2.0.0 versioning #4956

wants to merge 8 commits into from

Conversation

byrnHDF
Copy link
Contributor

@byrnHDF byrnHDF commented Oct 14, 2024

No description provided.

@byrnHDF byrnHDF added Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - New Feature Add a new API call, functionality, or tool Branch - 2.0 PRs to hdf5_2_0 labels Oct 14, 2024
@byrnHDF byrnHDF self-assigned this Oct 14, 2024
@derobins
Copy link
Member

As a part of this work, let's document what we had to update in the wiki. We should also try to minimize the places we have to update things using variables, etc.

hyoklee
hyoklee requested changes Oct 15, 2024
View reviewed changes
Copy link
Member

@hyoklee hyoklee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a few 4 digit versions. (e.g., 2.0.0.0 and 2.0.0.x)

c++/src/H5DcreatProp.cpp Outdated
@@ -702,7 +702,7 @@ DSetCreatPropList::getExternalCount() const
/// which is a 32-bit signed long value on Windows, which limited
/// the valid offset that can be returned to 2 GiB.
///
///\version 1.16.0 \p offset parameter type changed to HDoff_t from off_t.
///\version 2.0.0.0 \p offset parameter type changed to HDoff_t from off_t.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.0.0.0 -> 2.0.0

release_docs/RELEASE.txt Outdated
@@ -36,7 +36,7 @@ CONTENTS

- New Features
- Support for new platforms and languages
- Bug Fixes since HDF5-1.16.0
- Bug Fixes since HDF5-2.0.0.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.0.0.0 -> 2.0.0

release_docs/RELEASE.txt Outdated
@@ -128,7 +128,7 @@ Support for new platforms, languages and compilers
==================================================
-

Bug Fixes since HDF5-1.16.0 release
Bug Fixes since HDF5-2.0.0.0 release
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.0.0.0 -> 2.0.0

src/H5Ppublic.h Outdated
* \p high=<any version higher than \p low but not #H5F_LIBVER_LATEST></td>
* <td>
* \li The library will create objects with the latest format
* versions available to library release 1.16.x.
* versions available to library release 2.0.0.x.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.0.0.x -> 2.0.x

src/H5Ppublic.h
* \p high=<any version higher than \p low but not #H5F_LIBVER_LATEST></td>
* <td>
* \li The library will create objects with the latest format
* versions available to library release 1.18.x.
* versions available to library release 2.1.0.x.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.1.0.x -> 2.1.x

src/H5Ppublic.h Outdated
@@ -6067,7 +6067,7 @@ H5_DLL herr_t H5Pget_dset_no_attrs_hint(hid_t dcpl_id, hbool_t *minimize);
* which is a 32-bit signed long value on Windows, which limited
* the valid offset that can be returned to 2 GiB.
*
* \version 1.16.0 \p offset parameter type changed to HDoff_t from off_t.
* \version 2.0.0.0 \p offset parameter type changed to HDoff_t from off_t.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.0.0.0 -> 2.0.0

src/H5Ppublic.h Outdated
@@ -6564,7 +6564,7 @@ H5_DLL herr_t H5Pset_dset_no_attrs_hint(hid_t dcpl_id, hbool_t minimize);
* which is a 32-bit signed long value on Windows, which limited
* the valid offset that can be set to 2 GiB.
*
* \version 1.16.0 \p offset parameter type changed to HDoff_t from off_t.
* \version 2.0.0.0 \p offset parameter type changed to HDoff_t from off_t.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.0.0.0 -> 2.0.0

hyoklee
hyoklee requested changes Oct 15, 2024
View reviewed changes
Copy link
Member

@hyoklee hyoklee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still see 4 digit version.

CMakeLists.txt Outdated
endif ()

#-----------------------------------------------------------------------------
# Option to use 1.18.x API
# Option to use 2.1.0.x API
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.1.0.x -> 2.1.x

jhendersonHDF
jhendersonHDF reviewed Oct 16, 2024
View reviewed changes
config/cmake/H5pubconf.h.in
/* Define using v1.18 public API symbols by default */
#cmakedefine H5_USE_118_API_DEFAULT @H5_USE_118_API_DEFAULT@
/* Define using v2.1.0 public API symbols by default */
#cmakedefine H5_USE_210_API_DEFAULT @H5_USE_210_API_DEFAULT@
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From external discussions: if we assume that we're going to continue tying file format changes to major releases, it makes sense that the next API version should be 3.0 since the API wouldn't change in an incompatible way for a minor release (v2.0.0 -> v2.1.0). This also has the benefit of keeping the library version bounds a bit more sane (at least for a while), as they'll go V200 -> V300 -> V400 rather than v200 -> v210 ... -> v2110 (for a 2.1.10 release).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jhendersonHDF jhendersonHDF jhendersonHDF left review comments

@hyoklee hyoklee hyoklee approved these changes

@derobins derobins Awaiting requested review from derobins derobins is a code owner

@brtnfld brtnfld Awaiting requested review from brtnfld brtnfld is a code owner

@epourmal epourmal Awaiting requested review from epourmal epourmal is a code owner

@lrknox lrknox Awaiting requested review from lrknox lrknox is a code owner

@fortnern fortnern Awaiting requested review from fortnern fortnern is a code owner

@qkoziol qkoziol Awaiting requested review from qkoziol qkoziol is a code owner

@vchoi-hdfgroup vchoi-hdfgroup Awaiting requested review from vchoi-hdfgroup vchoi-hdfgroup is a code owner

@bmribler bmribler Awaiting requested review from bmribler bmribler is a code owner

@glennsong09 glennsong09 Awaiting requested review from glennsong09 glennsong09 is a code owner

@mattjala mattjala Awaiting requested review from mattjala mattjala is a code owner

Assignees

@byrnHDF byrnHDF

Labels
Branch - 2.0 PRs to hdf5_2_0 Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - New Feature Add a new API call, functionality, or tool
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@byrnHDF @derobins @hyoklee @jhendersonHDF