summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorjhendersonHDF <jhenderson@hdfgroup.org>2023-04-23 20:08:44 (GMT)
committerGitHub <noreply@github.com>2023-04-23 20:08:44 (GMT)
commit6f70a56098f5fb7d5944cff3ce520fc880a0b0bb (patch)
tree2c421019e4425793f1946a3981746a328c254e5a /src
parentea7dfcdf807781a537de20a841545bb823a17ecc (diff)
downloadhdf5-6f70a56098f5fb7d5944cff3ce520fc880a0b0bb.zip
hdf5-6f70a56098f5fb7d5944cff3ce520fc880a0b0bb.tar.gz
hdf5-6f70a56098f5fb7d5944cff3ce520fc880a0b0bb.tar.bz2
Add bug note to H5Dget_space_status documentation (#2788)
Diffstat (limited to 'src')
-rw-r--r--src/H5Dpublic.h14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/H5Dpublic.h b/src/H5Dpublic.h
index 9ec6f70..a1d1b06 100644
--- a/src/H5Dpublic.h
+++ b/src/H5Dpublic.h
@@ -461,6 +461,20 @@ H5_DLL hid_t H5Dget_space_async(hid_t dset_id, hid_t es_id);
* \details H5Dget_space_status() determines whether space has been allocated
* for the dataset \p dset_id.
*
+ * \note \Bold{BUG:} Prior to the HDF5 1.13.1, 1.12.2 and 1.10.9 releases,
+ * H5Dget_space_status() may return incorrect space allocation status
+ * values for datasets with filters applied to them.
+ * H5Dget_space_status() calculated the space allocation status by
+ * comparing the sum of the sizes of all the allocated chunks in the
+ * dataset against the total data size of the dataset, as calculated by
+ * the number of elements in the dataset's dataspace multiplied by the
+ * dataset's datatype size. If the dataset had any compression filters
+ * applied to it and the dataset chunks were successfully compressed,
+ * the sum of the sizes of the allocated dataset chunks would generally
+ * always be less than the total data size of the dataset, and
+ * H5Dget_space_status() wouldn't ever return
+ * `H5D_SPACE_STATUS_ALLOCATED`.
+ *
* \since 1.6.0
*
*/