summaryrefslogtreecommitdiffstats
path: root/release_docs
diff options
context:
space:
mode:
Diffstat (limited to 'release_docs')
-rw-r--r--release_docs/INSTALL_CMake.txt1
-rw-r--r--release_docs/RELEASE.txt33
2 files changed, 30 insertions, 4 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index ad030fa..94b14d9 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -785,7 +785,6 @@ HDF5_ENABLE_USING_MEMCHECKER "Indicate that a memory checker is used"
HDF5_GENERATE_HEADERS "Rebuild Generated Files" ON
HDF5_BUILD_GENERATORS "Build Test Generators" OFF
HDF5_JAVA_PACK_JRE "Package a JRE installer directory" OFF
-HDF5_MEMORY_ALLOC_SANITY_CHECK "Indicate that internal memory allocation sanity checks are enabled" OFF
HDF5_NO_PACKAGES "Do not include CPack Packaging" OFF
HDF5_PACK_EXAMPLES "Package the HDF5 Library Examples Compressed File" OFF
HDF5_PACK_MACOSX_FRAMEWORK "Package the HDF5 Library in a Frameworks" OFF
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index 5945e22..e435cae 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -47,13 +47,40 @@ New Features
Configuration:
-------------
- -
+ - Removal of memory allocation sanity checks configure options
+
+ With the removal of the memory allocation sanity checks feature, the
+ following configure options are no longer necessary and have been
+ removed:
+
+ Autotools:
+ --enable-memory-alloc-sanity-check
+
+ CMake:
+ HDF5_MEMORY_ALLOC_SANITY_CHECK
+ HDF5_ENABLE_MEMORY_STATS
+ (DER - 2022/11/03)
Library:
--------
- -
+ - Removal of memory allocation sanity checks feature
+
+ This feature added heap canaries and statistics tracking for internal
+ library memory operations. Unfortunately, the heap canaries caused
+ problems when library memory operations were mixed with standard C
+ library memory operations (such as in the filter pipeline, where
+ buffers may have to be reallocated). Since any platform with a C
+ compiler also usually has much more sophisticated memory sanity
+ checking tools than the HDF5 library provided (e.g., valgrind), we
+ have decided to to remove the feature entirely.
+
+ In addition to the configure changes described above, this also removes
+ the following from the public API:
+ H5get_alloc_stats()
+ H5_alloc_stats_t
+ (DER - 2022/11/03)
Parallel Library:
-----------------
@@ -125,7 +152,7 @@ Bug Fixes since HDF5-1.13.3 release
an application or library was built with the C library. Also updated the
CMake target link command to use the newer style MPI::MPI_C link variable.
- (ADB - 2022/20/27)
+ (ADB - 2022/10/27)
Tools