mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-03-31 17:10:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add helpful text to h5clear (#3754)

Browse Source 
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.
This commit is contained in:
bmribler 2023-10-23 15:46:56 -04:00 committed by GitHub
parent d76d591555
commit 744a20fc21
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
tools/src/misc/h5clear.c
View File

@ -61,6 +61,13 @@ static struct h5_long_options l_opts[] = {
static void
usage(const char *prog)
{
fprintf(stdout, "h5clear clears superblock status flag field, removes metadata cache image, prints\n");
fprintf(stdout, "EOA and EOF, or sets EOA of a file. It is not a general repair tool and should not\n");
fprintf(stdout, "be used to fix file corruption. If a process doesn't shut down cleanly, the\n");
fprintf(stdout, "superblock mark can be left that prevents opening a file without SWMR. Then,\n");
fprintf(stdout, "h5clear can be used to remove this superblock mark so that the file can be inspected\n");
fprintf(stdout, "and appropriate actions can be taken.\n");
fprintf(stdout, "\n");
fprintf(stdout, "usage: %s [OPTIONS] file_name\n", prog);
fprintf(stdout, " OPTIONS\n");
fprintf(stdout, " -h, --help Print a usage message and exit\n");
@ -73,8 +80,8 @@ usage(const char *prog)
fprintf(stdout,
" C is >= 0; C is optional and will default to 1M when not set.\n");
fprintf(stdout,
" This option helps to repair a crashed file where the stored EOA\n");
fprintf(stdout, " in the superblock is different from the actual EOF.\n");
" This option helps to repair a crashed SWMR file when the stored\n");
fprintf(stdout, " EOA in the superblock is different from the actual EOF.\n");
fprintf(stdout, " The file's EOA and EOF will be the same after applying\n");
fprintf(stdout, " this option to the file.\n");
fprintf(stdout, "\n");

11
tools/test/misc/expected/h5clear_missing_file.ddl
View File

@ -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.

11
tools/test/misc/expected/h5clear_usage.ddl
View File

@ -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.