Browse Source

Add HDF5 disk operations in doc

Corentin Salingue 8 years ago
parent
commit
832e0b2428

+ 2 - 1
doc/doxygen/chapters/501_environment_variables.doxy

@@ -905,7 +905,8 @@ full.
 This specifies then backend to be used by StarPU to push data when the main
 This specifies then backend to be used by StarPU to push data when the main
 memory is getting full. The default is unistd (i.e. using read/write functions),
 memory is getting full. The default is unistd (i.e. using read/write functions),
 other values are stdio (i.e. using fread/fwrite), unistd_o_direct (i.e. using
 other values are stdio (i.e. using fread/fwrite), unistd_o_direct (i.e. using
-read/write with O_DIRECT), and leveldb (i.e. using a leveldb database).
+read/write with O_DIRECT), leveldb (i.e. using a leveldb database), and hdf5 
+(i.e. using HDF5 library).
 </dd>
 </dd>
 
 
 <dt>STARPU_DISK_SWAP_SIZE</dt>
 <dt>STARPU_DISK_SWAP_SIZE</dt>

+ 14 - 0
doc/doxygen/chapters/510_configure_options.doxy

@@ -486,6 +486,20 @@ Specify the blas library to be used by some of the examples. Librairies availabl
 Enable linking with LevelDB if available
 Enable linking with LevelDB if available
 </dd>
 </dd>
 
 
+<dt>--with-hdf5-include-dir=<path></dt>
+<dd>
+\anchor with-hdf5-include-dir
+\addindex __configure__--with-hdf5-include-dir
+Specify the directory where is stored the header hdf5.h.
+</dd>
+
+<dt>--with-hdf5-lib-dir=<path></dt>
+<dd>
+\anchor with-hdf5-lib-dir
+\addindex __configure__--with-hdf5-lib-dir
+Specify the directory where is stored the hdf5 library.
+</dd>
+
 <dt>--disable-starpufft</dt>
 <dt>--disable-starpufft</dt>
 <dd>
 <dd>
 \anchor disable-starpufft
 \anchor disable-starpufft

+ 7 - 0
doc/doxygen/chapters/api/data_out_of_core.doxy

@@ -132,4 +132,11 @@ This set uses the leveldb created by Google <br />
 More information at https://code.google.com/p/leveldb/ <br />
 More information at https://code.google.com/p/leveldb/ <br />
 It doesn't support asynchronous transfers.
 It doesn't support asynchronous transfers.
 
 
+\var starpu_disk_hdf5_ops
+\ingroup API_Out_Of_Core
+This set uses the HDF5 library.<br />
+<strong>It doesn't support multiple opening from different processes. </strong> <br />
+You may only allow one process to write in the HDF5 file. <br />
+<strong>If HDF5 library is not compiled with --thread-safe you can't open more than one HDF5 file at the same time. </strong>
+
 */
 */