diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2023-09-11 12:48:13 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-09-11 12:48:13 (GMT) |
commit | fbeddf2c9c6141f4ed6e5638711ce8aa2b58b7c1 (patch) | |
tree | 1464673c827bbe822846a2120477999f423ea83d /doxygen/examples | |
parent | fbb9ad25963c5ca8c2f7827c30e9543df5528778 (diff) | |
download | hdf5-fbeddf2c9c6141f4ed6e5638711ce8aa2b58b7c1.zip hdf5-fbeddf2c9c6141f4ed6e5638711ce8aa2b58b7c1.tar.gz hdf5-fbeddf2c9c6141f4ed6e5638711ce8aa2b58b7c1.tar.bz2 |
Add missing row for the ROS3 VFD in table #3415 (#3517)
Diffstat (limited to 'doxygen/examples')
-rw-r--r-- | doxygen/examples/tables/fileDriverLists.dox | 144 | ||||
-rw-r--r-- | doxygen/examples/tables/propertyLists.dox | 13 |
2 files changed, 117 insertions, 40 deletions
diff --git a/doxygen/examples/tables/fileDriverLists.dox b/doxygen/examples/tables/fileDriverLists.dox index 125df63..b1f873f 100644 --- a/doxygen/examples/tables/fileDriverLists.dox +++ b/doxygen/examples/tables/fileDriverLists.dox @@ -8,32 +8,64 @@ <th>Description</th> </tr> <tr> +<td>#H5FD_SEC2</td> +<td>Serial I/O to file using Unix “section 2” functions.</td> +</tr> +<tr> <td>#H5FD_CORE</td> <td>Store in memory (optional backing store to disk file).</td> </tr> <tr> +<td>#H5FD_LOG</td> +<td>Store in logging file.</td> +</tr> +<tr> <td>#H5FD_FAMILY</td> <td>Store in a set of files.</td> </tr> <tr> -<td>#H5FD_LOG</td> -<td>Store in logging file.</td> +<td>#H5FD_MULTI</td> +<td>Store in multiple files. There are several options to control layout.</td> +</tr> +<tr> +<td>#H5FD_STDIO</td> +<td>Serial I/O to file using Unix “stdio” functions.</td> +</tr> +<tr> +<td>#H5FD_SPLITTER</td> +<td>Relays VFD calls to one VFD, and write calls to another VFD. Maintains two files.</td> </tr> <tr> <td>#H5FD_MPIO</td> <td>Store using MPI/IO.</td> </tr> <tr> -<td>#H5FD_MULTI</td> -<td>Store in multiple files. There are several options to control layout.</td> +<td>#H5FD_DIRECT</td> +<td>Forces data writes to the file directly without using the system kernel buffer.</td> </tr> <tr> -<td>#H5FD_SEC2</td> -<td>Serial I/O to file using Unix “section 2” functions.</td> +<td>#H5FD_MIRROR</td> +<td>Serial I/O to file using Unix “stdio” functions.</td> </tr> <tr> -<td>#H5FD_STDIO</td> -<td>Serial I/O to file using Unix “stdio” functions.</td> +<td>#H5FD_HDFS</td> +<td>Read-Only access to Hadoop Distributed File System (HDFS).</td> +</tr> +<tr> +<td>#H5FD_ROS3</td> +<td>Read-Only access to Amazon's S3 service.</td> +</tr> +<tr> +<td>#H5FD_SUBFILING</td> +<td>Derived from other "stacked" VFDs such as the splitter, mirror, and family VFDs.</td> +</tr> +<tr> +<td>#H5FD_IOC</td> +<td>Relays VFD calls to one VFD, and write calls to another VFD. Maintains two files.</td> +</tr> +<tr> +<td>#H5FD_ONION</td> +<td>Provide in-file provenance and revision/version control.</td> </tr> </table> //! [file_driver_table] @@ -57,33 +89,6 @@ the default file driver for all systems.</td> <td>#H5Pset_fapl_sec2</td> </tr> <tr> -<td>Direct</td> -<td>#H5FD_DIRECT</td> -<td>This is the #H5FD_SEC2 driver except data is written to or read from the file -synchronously without being cached by the system.</td> -<td>#H5Pset_fapl_direct</td> -</tr> -<tr> -<td>Log</td> -<td>#H5FD_LOG</td> -<td>This is the #H5FD_SEC2 driver with logging capabilities.</td> -<td>#H5Pset_fapl_log</td> -</tr> -<tr> -<td>Windows</td> -<td>#H5FD_WINDOWS</td> -<td>This driver was modified in HDF5-1.8.8 to be a wrapper of the POSIX driver, -#H5FD_SEC2. This change should not affect user applications.</td> -<td>#H5Pset_fapl_windows</td> -</tr> -<tr> -<td>STDIO</td> -<td>#H5FD_STDIO</td> -<td>This driver uses functions from the standard C stdio.h to perform I/O -to a single, permanent file on local disk with additional system buffering.</td> -<td>#H5Pset_fapl_stdio</td> -</tr> -<tr> <td>Memory</td> <td>#H5FD_CORE</td> <td>With this driver, an application can work with a file in memory for faster reads and @@ -92,6 +97,12 @@ version of the file can be written back to disk or abandoned.</td> <td>#H5Pset_fapl_core</td> </tr> <tr> +<td>Log</td> +<td>#H5FD_LOG</td> +<td>This is the #H5FD_SEC2 driver with logging capabilities.</td> +<td>#H5Pset_fapl_log</td> +</tr> +<tr> <td>Family</td> <td>#H5FD_FAMILY</td> <td>With this driver, the HDF5 file's address space is partitioned into pieces and sent to @@ -105,14 +116,21 @@ systems that do not support files larger than 2 gigabytes.</td> <td>With this driver, data can be stored in multiple files according to the type of the data. I/O might work better if data is stored in separate files based on the type of data. The Split driver is a special case of this driver.</td> -<td>#H5Pset_fapl_multi</td> +<td>#H5Pset_fapl_multi / #H5Pset_fapl_split</td> +</tr> +<tr> +<td>STDIO</td> +<td>#H5FD_STDIO</td> +<td>This driver uses functions from the standard C stdio.h to perform I/O +to a single, permanent file on local disk with additional system buffering.</td> +<td>#H5Pset_fapl_stdio</td> </tr> <tr> <td>Split</td> -<td>H5FD_SPLIT</td> +<td>#H5FD_SPLITTER</td> <td>This file driver splits a file into two parts. One part stores metadata, and the other part stores raw data. This splitting a file into two parts is a limited case of the Multi driver.</td> -<td>#H5Pset_fapl_split</td> +<td>#H5Pset_fapl_splitter</td> </tr> <tr> <td>Parallel</td> @@ -122,6 +140,56 @@ standard for both communication and file I/O.</td> <td>#H5Pset_fapl_mpio</td> </tr> <tr> +<td>Direct</td> +<td>#H5FD_DIRECT</td> +<td>This is the #H5FD_SEC2 driver except data is written to or read from the file +synchronously without being cached by the system.</td> +<td>#H5Pset_fapl_direct</td> +</tr> +<tr> +<td>Mirror</td> +<td>#H5FD_MIRROR</td> +<td>Serial I/O to file using Unix “stdio” functions.</td> +<td>#H5Pset_fapl_mirror</td> +</tr> +<tr> +<td>HDFS</td> +<td>#H5FD_HDFS</td> +<td>Read-Only access to Hadoop Distributed File System (HDFS).</td> +<td>#H5Pset_fapl_hdfs</td> +</tr> +<tr> +<td>ros3</td> +<td>#H5FD_ROS3</td> +<td>Read-Only access to Amazon's S3 service.</td> +<td>#H5Pset_fapl_ros3</td> +</tr> +<tr> +<td>Subfiling</td> +<td>#H5FD_SUBFILING</td> +<td>Derived from other "stacked" VFDs such as the splitter, mirror, and family VFDs.</td> +<td>#H5Pset_fapl_subfiling</td> +</tr> +<tr> +<td>IOC</td> +<td>#H5FD_IOC</td> +<td>Relays VFD calls to one VFD, and write calls to another VFD. Maintains two files.</td> +<td>#H5Pset_fapl_ioc</td> +</tr> +<tr> +<td>Onion</td> +<td>#H5FD_ONION</td> +<td>Provide in-file provenance and revision/version control.</td> +<td>#H5Pset_fapl_onion</td> +</tr> +<tr> +<td>Windows</td> +<td>#H5FD_WINDOWS</td> +<td>This driver was modified in HDF5-1.8.8 to be a wrapper of the POSIX driver, +#H5FD_SEC2. This change should not affect user applications.</td> +<td>#H5Pset_fapl_windows</td> +</tr> +<tr> <td>Parallel POSIX</td> <td>H5FD_MPIPOSIX</td> <td>This driver is no longer available</td> diff --git a/doxygen/examples/tables/propertyLists.dox b/doxygen/examples/tables/propertyLists.dox index 01570fa..2f74c03 100644 --- a/doxygen/examples/tables/propertyLists.dox +++ b/doxygen/examples/tables/propertyLists.dox @@ -351,7 +351,8 @@ larger than 2 gigabytes, or retrieves information regarding driver.</td> </tr> <tr> <td>#H5Pset_fapl_log</td> -<td>Sets logging driver.</td> +<td>The logging driver is a clone of the standard SEC2 (#H5FD_SEC2) driver with additional +facilities for logging metrics and activity to a file.</td> </tr> <tr> <td>#H5Pset_fapl_mirror/#H5Pget_fapl_mirror</td> @@ -376,15 +377,23 @@ or retrieves information regarding driver.</td> <td>Modifies/queries the file driver properties of the onion driver.</td> </tr> <tr> +<td>#H5Pset_fapl_ros3/#H5Pget_fapl_ros3</td> +<td>Modifies/queries the file driver properties of the ros3 driver.</td> +</tr> +<tr> <td>#H5Pset_fapl_sec2</td> <td>Sets driver for unbuffered permanent files or retrieves information regarding driver.</td> </tr> <tr> <td>#H5Pset_fapl_split</td> -<td>Sets driver for split files, a limited case of multiple files with one metadata file +<td>Sets driver for split files, a limited case of multi driver with one metadata file and one raw data file.</td> </tr> <tr> +<td>#H5Pset_fapl_splitter/#H5Pget_fapl_splitter</td> +<td>Modifies/queries the file driver properties of the splitter driver.</td> +</tr> +<tr> <td>#H5Pset_fapl_stdio</td> <td>Sets driver for buffered permanent files.</td> </tr> |