[svn-r20378] Purpose:

    Bug 2182 - h5ls and h5dump: update to use --enable-error-stack among tools, also update related descriptions

Description:
    Decided to use --enable-error-stack long option name only to 
    display error stack messages from HDF5 lib among tools.
    Updated to unify option name to '--enable-error-stack' for printing 
    HDF5 error stack messages for HDF5 tools. h5ls and h5dump for now.
    For h5ls, this replaces "-e/--errors" option, which is deprecated.
    For h5dump, remove -E from help page and RM , which was added by mistake
    before release1.8.7.
    Help page and RM got updated.
    Updated test case.

     
Tested:
 jam (linux32-LE), amani (linux64-LE), heiwa (linuxppc64-BE), tejeda (mac32-LE), linew (solaris-BE), Windows (32-LE)

10 files changed, 38 insertions, 10 deletions

diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index 8e4f164..d8c4a3f 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -510,6 +510,10 @@ Bug Fixes since HDF5-1.8.0 release
 
     Tools
     -----
+        - Updated to unify option name to '--enable-error-stack' for printing 
+          HDF5 error stack messages for HDF5 tools. h5ls and h5dump for now.
+          For h5ls, this replaces "-e/--errors" option, which is deprecated. 
+          Bug#2182 (JKM 2011/3/30)
         - Fixed output for H5T_REFERENCE in h5dump. According to the BNF document
           the output of a H5T_REFERENCE should be followed by the type;
           <reference> ::= H5T_REFERENCE { <ref_type> }
diff --git a/tools/h5dump/h5dump.c b/tools/h5dump/h5dump.c
index eec1265..f479774 100644
--- a/tools/h5dump/h5dump.c
+++ b/tools/h5dump/h5dump.c
@@ -663,7 +663,8 @@ usage(const char *prog)
     fprintf(stdout, "     -X S, --xml-ns=S      (XML Schema) Use qualified names n the XML\n");
     fprintf(stdout, "                          \":\": no namespace, default: \"hdf5:\"\n");
     fprintf(stdout, "                          E.g., to dump a file called `-f', use h5dump -- -f\n");
-    fprintf(stdout, "     -E, --enable-error-stack   Show all HDF5 error reporting\n");
+    fprintf(stdout, "     --enable-error-stack Prints messages from the HDF5 error stack as they\n");
+    fprintf(stdout, "                          occur.\n");
     fprintf(stdout, "\n");
     fprintf(stdout, " Subsetting is available by using the following options with a dataset\n");
     fprintf(stdout, " attribute. Subsetting is done by selecting a hyperslab from the data.\n");
diff --git a/tools/h5dump/testh5dump.sh.in b/tools/h5dump/testh5dump.sh.in
index 37dee72..d7b6cbd 100644
--- a/tools/h5dump/testh5dump.sh.in
+++ b/tools/h5dump/testh5dump.sh.in
@@ -631,7 +631,7 @@ TOOLTEST textlinkfar.ddl textlinkfar.h5
 TOOLTEST textlink.ddl textlink.h5
 
 # test for error stack display (BZ2048)
-TOOLTEST3 filter_fail.ddl -E filter_fail.h5
+TOOLTEST3 filter_fail.ddl --enable-error-stack filter_fail.h5
 
 # test for -o -y for dataset with attributes
 TOOLTEST tall-6.ddl -y -o data -d /g1/g1.1/dset1.1.1 tall.h5
diff --git a/tools/h5ls/h5ls.c b/tools/h5ls/h5ls.c
index 8987d03..722f45c 100644
--- a/tools/h5ls/h5ls.c
+++ b/tools/h5ls/h5ls.c
@@ -111,7 +111,8 @@ usage: %s [OPTIONS] [OBJECTS...]\n\
                    Must be used with -v, --verbose option.\n\
                    Provides no information for non-dataset objects.\n\
    -d, --data      Print the values of datasets\n\
-   -e, --errors    Show all HDF5 error reporting\n\
+   --enable-error-stack\n\
+                   Prints messages from the HDF5 error stack as they occur.\n\
    --follow-symlinks\n\
                    Follow symbolic links (soft links and external links)\n\
                    to display target object information.\n\
@@ -156,7 +157,9 @@ usage: %s [OPTIONS] [OBJECTS...]\n\
     updated to use the replacement option.\n\
 \n\
    -E or --external   Follow external links.\n\
-                      Replaced by --follow-symlinks.\n",
+                      Replaced by --follow-symlinks.\n\
+   -e, --errors       Show all HDF5 error reporting\n\
+                      Replaced by --enable-error-stack.\n",
      h5tools_getprogname());
 }
 
@@ -2295,6 +2298,9 @@ main(int argc, const char *argv[])
             address_g = TRUE;
         } else if(!HDstrcmp(argv[argno], "--data")) {
             data_g = TRUE;
+        } else if(!HDstrcmp(argv[argno], "--enable-error-stack")) {
+            show_errors_g = TRUE;
+        /* deprecated --errors */
         } else if(!HDstrcmp(argv[argno], "--errors")) {
             show_errors_g = TRUE;
         } else if(!HDstrcmp(argv[argno], "--follow-symlinks")) {
@@ -2380,6 +2386,7 @@ main(int argc, const char *argv[])
                         data_g = TRUE;
                         break;
 
+                    /* deprecated -e */
                     case 'e': /* --errors */
                         show_errors_g = TRUE;
                         break;
diff --git a/tools/testfiles/help-1.ls b/tools/testfiles/help-1.ls
index 7f8879c..e15a88b 100644
--- a/tools/testfiles/help-1.ls
+++ b/tools/testfiles/help-1.ls
@@ -10,7 +10,8 @@ usage: h5ls [OPTIONS] [OBJECTS...]
                    Must be used with -v, --verbose option.
                    Provides no information for non-dataset objects.
    -d, --data      Print the values of datasets
-   -e, --errors    Show all HDF5 error reporting
+   --enable-error-stack
+                   Prints messages from the HDF5 error stack as they occur.
    --follow-symlinks
                    Follow symbolic links (soft links and external links)
                    to display target object information.
@@ -56,3 +57,5 @@ usage: h5ls [OPTIONS] [OBJECTS...]
 
    -E or --external   Follow external links.
                       Replaced by --follow-symlinks.
+   -e, --errors       Show all HDF5 error reporting
+                      Replaced by --enable-error-stack.
diff --git a/tools/testfiles/help-2.ls b/tools/testfiles/help-2.ls
index 8bc31fb..7d035c0 100644
--- a/tools/testfiles/help-2.ls
+++ b/tools/testfiles/help-2.ls
@@ -10,7 +10,8 @@ usage: h5ls [OPTIONS] [OBJECTS...]
                    Must be used with -v, --verbose option.
                    Provides no information for non-dataset objects.
    -d, --data      Print the values of datasets
-   -e, --errors    Show all HDF5 error reporting
+   --enable-error-stack
+                   Prints messages from the HDF5 error stack as they occur.
    --follow-symlinks
                    Follow symbolic links (soft links and external links)
                    to display target object information.
@@ -56,3 +57,5 @@ usage: h5ls [OPTIONS] [OBJECTS...]
 
    -E or --external   Follow external links.
                       Replaced by --follow-symlinks.
+   -e, --errors       Show all HDF5 error reporting
+                      Replaced by --enable-error-stack.
diff --git a/tools/testfiles/help-3.ls b/tools/testfiles/help-3.ls
index 29aed97..8de1003 100644
--- a/tools/testfiles/help-3.ls
+++ b/tools/testfiles/help-3.ls
@@ -10,7 +10,8 @@ usage: h5ls [OPTIONS] [OBJECTS...]
                    Must be used with -v, --verbose option.
                    Provides no information for non-dataset objects.
    -d, --data      Print the values of datasets
-   -e, --errors    Show all HDF5 error reporting
+   --enable-error-stack
+                   Prints messages from the HDF5 error stack as they occur.
    --follow-symlinks
                    Follow symbolic links (soft links and external links)
                    to display target object information.
@@ -56,3 +57,5 @@ usage: h5ls [OPTIONS] [OBJECTS...]
 
    -E or --external   Follow external links.
                       Replaced by --follow-symlinks.
+   -e, --errors       Show all HDF5 error reporting
+                      Replaced by --enable-error-stack.
diff --git a/tools/testfiles/textlinksrc-nodangle-1.ls b/tools/testfiles/textlinksrc-nodangle-1.ls
index 306c4f9..9240761 100644
--- a/tools/testfiles/textlinksrc-nodangle-1.ls
+++ b/tools/testfiles/textlinksrc-nodangle-1.ls
@@ -12,7 +12,8 @@ usage: h5ls [OPTIONS] [OBJECTS...]
                    Must be used with -v, --verbose option.
                    Provides no information for non-dataset objects.
    -d, --data      Print the values of datasets
-   -e, --errors    Show all HDF5 error reporting
+   --enable-error-stack
+                   Prints messages from the HDF5 error stack as they occur.
    --follow-symlinks
                    Follow symbolic links (soft links and external links)
                    to display target object information.
@@ -58,3 +59,5 @@ usage: h5ls [OPTIONS] [OBJECTS...]
 
    -E or --external   Follow external links.
                       Replaced by --follow-symlinks.
+   -e, --errors       Show all HDF5 error reporting
+                      Replaced by --enable-error-stack.
diff --git a/tools/testfiles/tgroup-1.ls b/tools/testfiles/tgroup-1.ls
index 54c139c..04066ca 100644
--- a/tools/testfiles/tgroup-1.ls
+++ b/tools/testfiles/tgroup-1.ls
@@ -12,7 +12,8 @@ usage: h5ls [OPTIONS] [OBJECTS...]
                    Must be used with -v, --verbose option.
                    Provides no information for non-dataset objects.
    -d, --data      Print the values of datasets
-   -e, --errors    Show all HDF5 error reporting
+   --enable-error-stack
+                   Prints messages from the HDF5 error stack as they occur.
    --follow-symlinks
                    Follow symbolic links (soft links and external links)
                    to display target object information.
@@ -58,3 +59,5 @@ usage: h5ls [OPTIONS] [OBJECTS...]
 
    -E or --external   Follow external links.
                       Replaced by --follow-symlinks.
+   -e, --errors       Show all HDF5 error reporting
+                      Replaced by --enable-error-stack.
diff --git a/tools/testfiles/tnofilename.ddl b/tools/testfiles/tnofilename.ddl
index 7845675..0e78217 100644
--- a/tools/testfiles/tnofilename.ddl
+++ b/tools/testfiles/tnofilename.ddl
@@ -35,7 +35,8 @@ usage: h5dump [OPTIONS] file
      -X S, --xml-ns=S      (XML Schema) Use qualified names n the XML
                           ":": no namespace, default: "hdf5:"
                           E.g., to dump a file called `-f', use h5dump -- -f
-     -E, --enable-error-stack   Show all HDF5 error reporting
+     --enable-error-stack Prints messages from the HDF5 error stack as they
+                          occur.
 
  Subsetting is available by using the following options with a dataset
  attribute. Subsetting is done by selecting a hyperslab from the data.