summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2021-01-15 23:38:03 (GMT)
committerGitHub <noreply@github.com>2021-01-15 23:38:03 (GMT)
commit9578160cefb794fc2fde7c8040c945df498b9e4a (patch)
tree977c4f05096eb3095d8e99fe54aaea826fe134d6
parenta1091585ad897ee93ffcb0ba435fa4930a1e8572 (diff)
downloadhdf5-9578160cefb794fc2fde7c8040c945df498b9e4a.zip
hdf5-9578160cefb794fc2fde7c8040c945df498b9e4a.tar.gz
hdf5-9578160cefb794fc2fde7c8040c945df498b9e4a.tar.bz2
11099 Add help text line (#259)
* OESS-98 convert plugin option to FetchContent, add tests * Fixes for pkcfg files because of plugin option * OESS-98 fix tools test for plugins * Keep doxygen comments under 100 chars long - format hint * Whitespace * HDFFV-11144 - Reclassify CMake messages * HDFFV-11099/11100 added help text
-rw-r--r--release_docs/RELEASE.txt8
-rw-r--r--tools/src/h5repack/h5repack_main.c1
-rw-r--r--tools/test/h5repack/testfiles/h5repack-help.txt1
3 files changed, 10 insertions, 0 deletions
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index 262ae00..24fe4c1 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -576,6 +576,14 @@ New Features
Tools:
------
+ - h5repack added help text for user-defined filters.
+
+ Added help text line that states the valid values of the filter flag
+ for user-defined filters;
+ filter_flag: 1 is OPTIONAL or 0 is MANDATORY
+
+ (ADB - 2021/01/14, HDFFV-11099)
+
- Added h5delete tool
Deleting HDF5 storage when using the VOL can be tricky when the VOL
diff --git a/tools/src/h5repack/h5repack_main.c b/tools/src/h5repack/h5repack_main.c
index c38dd66..a67d6ac 100644
--- a/tools/src/h5repack/h5repack_main.c
+++ b/tools/src/h5repack/h5repack_main.c
@@ -262,6 +262,7 @@ usage(const char *prog)
PRINTVALSTREAM(rawoutstream,
" Required values: filter_number, filter_flag, cd_value_count, value1\n");
PRINTVALSTREAM(rawoutstream, " Optional values: value2 to valueN\n");
+ PRINTVALSTREAM(rawoutstream, " filter_flag: 1 is OPTIONAL or 0 is MANDATORY\n");
PRINTVALSTREAM(rawoutstream, " NONE (no parameter)\n");
PRINTVALSTREAM(rawoutstream, "\n");
PRINTVALSTREAM(rawoutstream, " LAYT - is a string with the format:\n");
diff --git a/tools/test/h5repack/testfiles/h5repack-help.txt b/tools/test/h5repack/testfiles/h5repack-help.txt
index e12838d..cb10d22 100644
--- a/tools/test/h5repack/testfiles/h5repack-help.txt
+++ b/tools/test/h5repack/testfiles/h5repack-help.txt
@@ -136,6 +136,7 @@ usage: h5repack [OPTIONS] file1 file2
UD=<filter_number,filter_flag,cd_value_count,value1[,value2,...,valueN]>
Required values: filter_number, filter_flag, cd_value_count, value1
Optional values: value2 to valueN
+ filter_flag: 1 is OPTIONAL or 0 is MANDATORY
NONE (no parameter)
LAYT - is a string with the format: