mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-11-21 01:04:10 +08:00
Code Issues Packages Projects Releases Wiki Activity
3d09a7d5f6
hdf5/release_docs
History
Dana Robinson 3d09a7d5f6
Remove H5B debug checks (#4089) 
The H5B (version 1 B-tree) package would add some computationally
expensive integrity checks when H5B_DEBUG was defined. Due to their
negative effects on performance, this option was rarely turned on,
making the H5B__assert() check function stale, if not dead, code.

This change:

* Builds H5B__assert() when NDEBUG is not defined (the function
  relies on assert()) so it gets compiled more often.
* Removes some printf debugging statements in the B-tree code
* Removes all H5B "extra debug" checks that are leftover from
  past debugging sessions. Maintainers can add H5B__assert()
  selectively to perform integrity checks when debugging.
* Removes the HDF5_ENABLE_DEBUG_H5B CMake option

H5B_DEBUG now has no effect
2024-03-08 23:17:13 -08:00
..
HISTORY-1_0-1_8_0.txt
HISTORY-1_8_0-1_10_0.txt
HISTORY-1_10_0-1_12_0.txt
HISTORY-1_12_0-1_14_0.txt
INSTALL Update and Add general INSTALL (#4016) 2024-02-23 08:02:18 -06:00
INSTALL_Auto.txt Update and Add general INSTALL (#4016) 2024-02-23 08:02:18 -06:00
INSTALL_CMake.txt New option for building with static CRT in Windows (#4062) 2024-03-07 09:27:56 -08:00
INSTALL_Cygwin.txt Some changes to portal links when they could be found on docs.hdfgroup.org, and changed the helpdesk link to help.hdfgroup.org (#3893) 2023-12-12 22:21:15 -06:00
INSTALL_parallel Replace deprecated Fortran 'include mpif.h' with 'USE mpi' (#4031) 2024-02-21 14:04:38 -06:00
INSTALL_Warnings.txt
INSTALL_Windows.txt
NEWSLETTER.txt
README_HDF5_CMake
README_HPC
README.md
RELEASE.txt Remove H5B debug checks (#4089) 2024-03-08 23:17:13 -08:00
USING_CMake_Examples.txt Update and Add general INSTALL (#4016) 2024-02-23 08:02:18 -06:00
USING_HDF5_CMake.txt Update INSTALL files (#4052) 2024-03-05 14:42:08 -08:00
USING_HDF5_VS.txt Update INSTALL files (#4052) 2024-03-05 14:42:08 -08: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.