diff options
author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2022-12-27 20:57:01 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-12-27 20:57:01 (GMT) |
commit | e985e8d7fa9c74c4e50c0f836fc2f70478792779 (patch) | |
tree | 3f29c3bc76cc28f20e6ab5aec4b090be2ad1dfa3 /src/H5VLmodule.h | |
parent | e783b100d473f0e4f77147f3b89b0a73cb09126a (diff) | |
download | hdf5-e985e8d7fa9c74c4e50c0f836fc2f70478792779.zip hdf5-e985e8d7fa9c74c4e50c0f836fc2f70478792779.tar.gz hdf5-e985e8d7fa9c74c4e50c0f836fc2f70478792779.tar.bz2 |
Brings Doxygen changes from develop (#2366)
Diffstat (limited to 'src/H5VLmodule.h')
-rw-r--r-- | src/H5VLmodule.h | 16 |
1 files changed, 4 insertions, 12 deletions
diff --git a/src/H5VLmodule.h b/src/H5VLmodule.h index d6e65db..169134a 100644 --- a/src/H5VLmodule.h +++ b/src/H5VLmodule.h @@ -122,22 +122,14 @@ * specifying a name in the VOL plugin environment variable. * * \subsubsection subsubsec_vol_quick_use Use A VOL-Enabled HDF5 Library - * The virtual object layer was introduced in HDF5 1.12.0, however that version of the VOL is deprecated. - * VOL users should target HDF5 1.13.X, which is currently under development. The 1.13.X releases are - * considered ”unstable” in the sense that API calls, interfaces, and the file format may change in the - * 1.13.X release branches and we do not guarantee binary compatibility (”unstable” does NOT mean buggy). - * The next stable version of the library will be HDF5 1.14.0 which will release in 2023. The particular - * configuration of the library (serial vs parallel, thread-safe, debug vs production/release) does not - * matter. The VOL is a fundamental part of the library and cannot be disabled, so any build will do. + * The virtual object layer was introduced in HDF5 1.12.0, however that version of the VOL is deprecated + * due to inadequate support for pass-through connectors. These deficiencies have been addressed + * in HDF5 1.14.0, so VOL users and connector authors should target the 1.14.0 VOL API. * * On Windows, it’s probably best to use the same debug vs release configuration for the application and * all libraries in order to avoid C runtime (CRT) issues. Pre-2015 versions of Visual Studio are not * supported. * - * When working with a debug HDF5 library, it’s probably also wise to build with the ”memory sanity checking” - * feature disabled to avoid accidentally clobbering our memory tracking infrastructure when dealing with - * buffers obtained from the HDF5 library. This feature should be disabled by default in HDF5 1.13.X. - * * \subsubsection subsubsec_vol_quick_set Determine How You Will Set The VOL Connector * Fundamentally, setting a VOL connector involves modifying the file access property list (fapl) that will * be used to open or create the file. @@ -505,7 +497,7 @@ * \endcode * * \subsubsection subsubsec_vol_adapt_native Protect Native-Only API Calls - * In HDF5 1.13.0, a way to determine support for optional calls has been added. + * In HDF5 1.14.0, a way to determine support for optional calls has been added. * \code * herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, uint64_t *flags) * \endcode |