diff --git a/README.md b/README.md index 8e4fe020efb..4ea87606a2f 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ # Experimental -This repo contains the modified source code of HDF5 r1.14.2, which is in the 1_14_2_multithread -branch. The code will be used to prototype changes for multi-threaded support before creating PRs -to the HDF5 develop branch. This is for Lifeboat's internal use only but anyone is welcome to watch -our progress. - -One must use the --enable-multithread for configure to enable the multithread support. On Mac OS, -this option requires the presence of Pthread library and the Atomic header (stdatomic.h). On Linux, -it requires the presence of Pthread and Atomic libraries and the Atomic header. Missing any of these -requirements will cause configure to fail. Using the multithread feature requires disabling the high-level -API, C++, Fortran, Java interfaces, and thread safe. This feature currently only works with debugging -mode (--enable-build-mode=debug), not the production mode (we are still working on it). +This branch contains modified source code of HDF5 r1.14.2. The code will be used to +prototype changes for multi-threaded support before creating PRs to the HDF5 develop +branch. This is for Lifeboat's internal use only but anyone is welcome to watch our +progress. + +One must use the --enable-multithread option for configure to enable the multithread +support. On Mac OS, this option requires the presence of the Pthread library and the +Atomic header (stdatomic.h). On Linux, it requires the presence of the Pthread and +Atomic libraries and the Atomic header. Missing any of these requirements will cause +configure to fail. Using the multithread feature requires disabling the high-level +API, C++, Fortran, Java interfaces, and thread safe. The following command is an example to enable the multithread support: > configure --enable-multithread --enable-build-mode=debug --disable-hl -The only test program to check the correctness of multithread support is hdf5/test/mt_id_test.c. During -the build of the library and the test program, there are multiple warnings related to the atomic issues -that we're investigating and fixing. +Currently, the only test program to check the correctness of multithread support is +test/mt_id_test.c. During the build of the library and the test program, there are +multiple warnings related to the atomic issues that we're investigating and fixing. -------------