mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-02-23 16:20:57 +08:00
Code Issues Packages Projects Releases Wiki Activity
a91be87f07
hdf5/release_docs
History
jhendersonHDF a91be87f07
Sync with develop (#3764) 
* Add missing test files to distclean target (#3734)

Cleans up new files in Autotools `make distclean` in the test directory

* Add tools/libtest to Autotools builds (#3735)

This was only added to CMake many years ago and tests the tools
library.

* Clean up onion VFD files in tools `make clean` (#3739)

Cleans up h5dump and h5diff *.onion files in the Autotools when
runing `make clean`.

* Clean Java test files on Autotools (#3740)

Removes generated HDF5 and text output files when running `make clean`.

* Clean the flushrefresh test dir on Autotools (#3741)

The flushrefresh_test directory was not being cleaned up w/
`make clean` under the Autotools

* Fix file names in tfile.c (#3743)

Some tests in tfile.c use h5_fileaccess to get a VFD-dependent file
name but use the scheme from testhdf5, reusing the FILE1 and FILE8
names. This leads to files like test1.h5.h5 which are unintended
and not cleaned up.

This changes the filename scheme for a few tests to work with h5test,
resulting in more informative names and allowing the files to
be cleaned up at the end of the test. The test files have also
been added to the `make clean` target for the Autotools.

* Clean Autotools files in parallel tests (#3744)

Adds missing files to `make clean` for parallel, including Fortran.

* Add native VOL checks to deprecated functions (#3647)

* Add native VOL checks to deprecated functions

* Remove unneeded native VOL checks

* Move native checks to top level calls

* Fix buffer overflow in cache debugging code (#3691)

* update stat arg for apple (#3726)

* update stat arg for apple

* use H5_HAVE_DARWIN for Apple ifdef

* fix typo

* removed duplicate H5_ih_info_t

* added fortran async test to cmake

* Fix windows cpack error in WiX package. (#3747)

* Add a simple cache to the ros3 VFD (#3753)

Adds a small cache of the first N bytes of a file opened with the
read-only S3 (ros3) VFD, where N is 4kiB or the size of the file,
whichever is smaller. This avoids a lot of small I/O operations
on file open.

Addresses GitHub issue #3381

* Update Autotools to correctly configure oneAPI (#3751)

* Update Autotools to correctly configure oneAPI

Splits the Intel config files under the Autotools into 'classic'
Intel and oneAPI versions, fixing 'unsupported option' messages.

Also turns off `-check uninit` (new in 2023) in Fortran, which kills
the H5_buildiface program due to false positives.

* Enable Fortran in oneAPI CI workflow

* Turn on Fortran in CMake, update LD_LIBRARY_PATH

* Go back to disabling Fortran w/ Intel

For some reason there's a linking problem w/ Fortran

error while loading shared libraries: libifport.so.5: cannot open shared object file: No such file or directory

* Add h5pget_actual_selection_io_mode fortran wrapper (#3746)

* added h5pget_actual_selection_io_mode_f test

* added tests for h5pget_actual_selection_io_mode_f

* fixed int_f type conversion

* Update fortran action step (#3748)

* Added missing DLL for H5PGET_ACTUAL_SELECTION_IO_MODE_F (#3760)

* add missing H5PGET_ACTUAL_SELECTION_IO_MODE_F dll

* Bump the ros3 VFD cache to 16 MiB (#3759)

* Fix hangs during collective I/O with independent metadata writes (#3693)

* Fix some issues with collective metadata reads for chunked datasets (#3716)

Add functions/callbacks for explicit control over chunk index open/close

Add functions/callbacks to check if chunk index is open or not so
that it can be opened if necessary before temporarily disabling
collective metadata reads in the library

Add functions/callbacks for requesting loading of additional chunk
index metadata beyond the chunk index itself

* Fix failure in t_select_io_dset when run with more than 10 ranks (#3758)

* Fix H5Pset_evict_on_close failing regardless of actual parallel use (#3761)

Allow H5Pset_evict_on_close to be called regardless of whether a parallel build of HDF5 is being used

Fail during file opens if H5Pset_evict_on_close has been set to true on the given File Access Property List and the size of the MPI communicator being used is greater than 1
2023-10-24 19:36:18 -05:00
..
HISTORY-1_0-1_8_0.txt Fix several spelling/grammar issues (#3621) (#3632) 2023-10-04 02:55:03 -07:00
HISTORY-1_8_0-1_10_0.txt Fix several spelling/grammar issues (#3621) (#3632) 2023-10-04 02:55:03 -07:00
HISTORY-1_10_0-1_12_0.txt Fix several spelling/grammar issues (#3621) (#3632) 2023-10-04 02:55:03 -07:00
HISTORY-1_14.txt Fix several spelling/grammar issues (#3621) (#3632) 2023-10-04 02:55:03 -07:00
INSTALL Merge with develop (#2790) 2023-04-21 23:25:12 -07:00
INSTALL_CMake.txt GH issue 3398 - option to disable doxygen warn as error (#3709) 2023-10-19 15:26:39 -07:00
INSTALL_Cygwin.txt 1.14 sync with develop (#3660) 2023-10-12 11:32:23 -05:00
INSTALL_parallel Updated the parallel install docs. 2018-12-31 05:07:30 -08:00
INSTALL_Warnings.txt Removed mentions of Wdeclaration-after-statement now that C99 is requ… (#447) 2021-05-03 09:08:37 -05:00
INSTALL_Windows.txt [svn-r28397] Add note about the "H5_BUILT_AS_DYNAMIC_LIB" compile definition 2015-11-18 15:26:11 -05:00
NEWSLETTER.txt 1.14 sync with develop (#3660) 2023-10-12 11:32:23 -05:00
README_HDF5_CMake Merge with develop (#2790) 2023-04-21 23:25:12 -07:00
README_HPC Bring the H5detect removal change from develop (#3648) 2023-10-09 10:42:46 -07:00
README.md Update release_docs HISTORY scheme (#2443) 2023-02-13 06:03:11 -08:00
RELEASE.txt Sync with develop (#3764) 2023-10-24 19:36:18 -05:00
USING_CMake_Examples.txt Merge with develop (#2790) 2023-04-21 23:25:12 -07:00
USING_HDF5_CMake.txt Merge with develop (#2790) 2023-04-21 23:25:12 -07:00
USING_HDF5_VS.txt Add Fortran H5ES module to deploy list (#3342) 2023-08-05 14:07:55 -05:00

README.md

The release_docs directory

Intro

This directory contains instructions for building and using the library as well as the HDF5 history files.

HISTORY files

The HISTORY files contain the history of this branch of HDF5. They fall into three categories.

HISTORY-[VERSION 1]-[VERSION 2].txt

These files are created when we release a new major version and include all the changes that were made to the develop branch while creating a major release.

HISTORY-[VERSION].txt

This file contains the changes that were made to a maintenance branch since it split off from develop. It will also be found in the develop branch when experimental releases have been created.

RELEASE.txt

This is the changelog for the current version of the library.

For a MAJOR release (or in develop) this files lists all the changes since the last major version. For a MINOR release (or in a maintenance branch), this file lists all the changes since the last release in the maintenance branch.

Examples:

  • The file for HDF5 1.14.0 includes all the changes since HDF5 1.12.0
  • The file for HDF5 1.10.9 includes all the changes since HDF5 1.10.8
  • The file in develop includes all the changes since the last major release
  • The file in hdf5_1_14 includes all the changes since the last minor HDF5 1.14 release

Note that we make no effort to bring maintenance branch HISTORY files back to develop. If you want to compare, say, 1.10.4 with 1.12.3, you'd have to get the history files from those releases and compare them by hand.

Creating new releases

MAJOR release

  • If there were experimental releases, merge the experimental HISTORY file and the current RELEASE.txt by category to create a separate, unified file that ignores the experimental releases. Don't check this in yet or clobber any existing HISTORY/RELEASE files, but put it someplace handy for use in later steps.

  • Create the new maintenance branch

In develop:

  • Create the new HISTORY-\[VERSION 1\]-\[VERSION 2\].txt file
    • If there is an experimental HISTORY file, add RELEASE.txt to the beginning of it and use that
    • Otherwise, start with RELEASE.txt
    • Add the introduction boilerplate like in the other HISTORY files (TOC, etc.)
  • Delete any experimental HISTORY file
  • Clear out RELEASE.txt

Note that we're KEEPING any experimental release history information in the HISTORY-\[VERSION 1\]-\[VERSION 2\].txt file, so do NOT use the merged file in the above steps!

In the new maintenance branch:

  • Create the new HISTORY-\[VERSION\].txt file

    • If there is an experimental HISTORY file use the combined file you created earlier
    • Otherwise, start with RELEASE.txt
    • Add the introduction boilerplate like in the other HISTORY files (TOC, etc.)

  • Delete any experimental HISTORY file

  • Clear out RELEASE.txt

  • Create the new release branch

In the new release branch:

  • If there were experimental releases, use the combined file you created earlier as RELEASE.txt
  • Otherwise the RELEASE.txt will be used as-is

MINOR release

  • Create the release branch

In the maintenance branch:

  • Add the contents of RELEASE.txt to the beginnnig of HISTORY-\[VERSION\].txt
  • Clear out RELEASE.txt

EXPERIMENTAL release

  • Add the contents of RELEASE.txt to the beginnnig of HISTORY-\[VERSION\].txt
  • Clear out RELEASE.txt

INSTALL files

These files include instructions for building and installing HDF5 on various platforms.

USING files

These files document how to build HDF5 applications with an installed HDF5 library.