diff options
| author | bmribler <39579120+bmribler@users.noreply.github.com> | 2023-10-23 19:47:17 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-23 19:47:17 (GMT) |
| commit | 45c1c875716ab27a7d9fe5f99d16e3353e78c466 (patch) | |
| tree | b1cbcbb477334f4fdad43fab9f82eab9b0dee43e /tools/test/misc | |
| parent | d3a5008b3645601bd9506d40706656e71fc26b1c (diff) | |
| download | hdf5-45c1c875716ab27a7d9fe5f99d16e3353e78c466.zip hdf5-45c1c875716ab27a7d9fe5f99d16e3353e78c466.tar.gz hdf5-45c1c875716ab27a7d9fe5f99d16e3353e78c466.tar.bz2 | |
Improve the usage of h5clear (#3757)
- Added text to the usage of h5clear to explain that this tool is not for fixing
corrupted files but simply for helping in the inspection of the damage.
- Fixed expected output for testing the modified usage.
Fixed GH #3054
Diffstat (limited to 'tools/test/misc')
| -rw-r--r-- | tools/test/misc/expected/h5clear_missing_file.ddl | 11 | ||||
| -rw-r--r-- | tools/test/misc/expected/h5clear_usage.ddl | 11 |
2 files changed, 18 insertions, 4 deletions
diff --git a/tools/test/misc/expected/h5clear_missing_file.ddl b/tools/test/misc/expected/h5clear_missing_file.ddl index c7a2118..fe659af 100644 --- a/tools/test/misc/expected/h5clear_missing_file.ddl +++ b/tools/test/misc/expected/h5clear_missing_file.ddl @@ -1,3 +1,10 @@ +h5clear clears superblock status flag field, removes metadata cache image, prints +EOA and EOF, or sets EOA of a file. It is not a general repair tool and should not +be used to fix file corruption. If a process doesn't shut down cleanly, the +superblock mark can be left that prevents opening a file without SWMR. Then, +h5clear can be used to remove this superblock mark so that the file can be inspected +and appropriate actions can be taken. + usage: h5clear [OPTIONS] file_name OPTIONS -h, --help Print a usage message and exit @@ -8,8 +15,8 @@ usage: h5clear [OPTIONS] file_name --increment=C Set the file's EOA to the maximum of (EOA, EOF) + C for the file <file_name>. C is >= 0; C is optional and will default to 1M when not set. - This option helps to repair a crashed file where the stored EOA - in the superblock is different from the actual EOF. + This option helps to repair a crashed SWMR file when the stored + EOA in the superblock is different from the actual EOF. The file's EOA and EOF will be the same after applying this option to the file. diff --git a/tools/test/misc/expected/h5clear_usage.ddl b/tools/test/misc/expected/h5clear_usage.ddl index c7a2118..fe659af 100644 --- a/tools/test/misc/expected/h5clear_usage.ddl +++ b/tools/test/misc/expected/h5clear_usage.ddl @@ -1,3 +1,10 @@ +h5clear clears superblock status flag field, removes metadata cache image, prints +EOA and EOF, or sets EOA of a file. It is not a general repair tool and should not +be used to fix file corruption. If a process doesn't shut down cleanly, the +superblock mark can be left that prevents opening a file without SWMR. Then, +h5clear can be used to remove this superblock mark so that the file can be inspected +and appropriate actions can be taken. + usage: h5clear [OPTIONS] file_name OPTIONS -h, --help Print a usage message and exit @@ -8,8 +15,8 @@ usage: h5clear [OPTIONS] file_name --increment=C Set the file's EOA to the maximum of (EOA, EOF) + C for the file <file_name>. C is >= 0; C is optional and will default to 1M when not set. - This option helps to repair a crashed file where the stored EOA - in the superblock is different from the actual EOF. + This option helps to repair a crashed SWMR file when the stored + EOA in the superblock is different from the actual EOF. The file's EOA and EOF will be the same after applying this option to the file. |