summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVailin Choi <vchoi@hdfgroup.org>2020-06-11 21:30:42 (GMT)
committerVailin Choi <vchoi@hdfgroup.org>2020-06-11 21:30:42 (GMT)
commitf295ed11665116cc264461b91b028949b2ac8d78 (patch)
tree29d1d26de238b9bb5950728e2155f223ea518764
parent3650841a0a307e512bcc9aa04332ce72a780fc69 (diff)
parent01b632c69ca1c97c2b0e1aaeeab1dd2362b580a6 (diff)
downloadhdf5-f295ed11665116cc264461b91b028949b2ac8d78.zip
hdf5-f295ed11665116cc264461b91b028949b2ac8d78.tar.gz
hdf5-f295ed11665116cc264461b91b028949b2ac8d78.tar.bz2
Merge pull request #2643 in HDFFV/hdf5 from ~VCHOI/my_third_fork:bugfix/HDFFV-10961-h5clear-usage-statement-give to develop
* commit '01b632c69ca1c97c2b0e1aaeeab1dd2362b580a6': Fix for HDFFV-10961: Couple changes to the tests' usage output files for h5clear. Fix for HDFFV-10961: add description to usage for --increment option.
-rw-r--r--tools/src/misc/h5clear.c9
-rw-r--r--tools/test/misc/testfiles/h5clear_missing_file.ddl10
-rw-r--r--tools/test/misc/testfiles/h5clear_usage.ddl10
3 files changed, 23 insertions, 6 deletions
diff --git a/tools/src/misc/h5clear.c b/tools/src/misc/h5clear.c
index 2c85e75..f95d1bc 100644
--- a/tools/src/misc/h5clear.c
+++ b/tools/src/misc/h5clear.c
@@ -101,8 +101,13 @@ static void usage(const char *prog)
HDfprintf(stdout, " -s, --status Clear the status_flags field in the file's superblock\n");
HDfprintf(stdout, " -m, --image Remove the metadata cache image from the file\n");
HDfprintf(stdout, " --filesize Print the file's EOA and EOF\n");
- HDfprintf(stdout, " --increment=C Set the file's EOA to the maximum of (EOA, EOF) + C for the file <file_name>\n");
- HDfprintf(stdout, " C is >= 0; C is optional and will default to 1M when not set");
+ HDfprintf(stdout, " --increment=C Set the file's EOA to the maximum of (EOA, EOF) + C for\n");
+ HDfprintf(stdout, " the file <file_name>.\n");
+ HDfprintf(stdout, " C is >= 0; C is optional and will default to 1M when not set.\n");
+ HDfprintf(stdout, " This option helps to repair a crashed file where the stored EOA\n");
+ HDfprintf(stdout, " in the superblock is different from the actual EOF.\n");
+ HDfprintf(stdout, " The file’s EOA and EOF will be the same after applying\n");
+ HDfprintf(stdout, " this option to the file.\n");
HDfprintf(stdout, "\n");
HDfprintf(stdout, "Examples of use:\n");
HDfprintf(stdout, "\n");
diff --git a/tools/test/misc/testfiles/h5clear_missing_file.ddl b/tools/test/misc/testfiles/h5clear_missing_file.ddl
index 32dd549..c4d21c9 100644
--- a/tools/test/misc/testfiles/h5clear_missing_file.ddl
+++ b/tools/test/misc/testfiles/h5clear_missing_file.ddl
@@ -5,8 +5,14 @@ usage: h5clear [OPTIONS] file_name
-s, --status Clear the status_flags field in the file's superblock
-m, --image Remove the metadata cache image from the file
--filesize Print the file's EOA and EOF
- --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
+ --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.
+ The file’s EOA and EOF will be the same after applying
+ this option to the file.
+
Examples of use:
h5clear -s file_name
diff --git a/tools/test/misc/testfiles/h5clear_usage.ddl b/tools/test/misc/testfiles/h5clear_usage.ddl
index 32dd549..c4d21c9 100644
--- a/tools/test/misc/testfiles/h5clear_usage.ddl
+++ b/tools/test/misc/testfiles/h5clear_usage.ddl
@@ -5,8 +5,14 @@ usage: h5clear [OPTIONS] file_name
-s, --status Clear the status_flags field in the file's superblock
-m, --image Remove the metadata cache image from the file
--filesize Print the file's EOA and EOF
- --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
+ --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.
+ The file’s EOA and EOF will be the same after applying
+ this option to the file.
+
Examples of use:
h5clear -s file_name