[svn-r19491] Purpose:

 Update help page for exclude-path feature.

Description:
 Related to "1890:  h5diff excluding object for file comparison via command line" checkins. (r19406)

Tested:
 jam, amani, heiwa

1 files changed, 24 insertions, 0 deletions

diff --git a/tools/h5diff/h5diff_common.c b/tools/h5diff/h5diff_common.c
index a678b2f..84eb49a 100644
--- a/tools/h5diff/h5diff_common.c
+++ b/tools/h5diff/h5diff_common.c
@@ -453,6 +453,30 @@ void usage(void)
  printf("                           comparing floating point values.\n");
  printf("                           By default, strict equality is used. Use -p or -d to\n");
  printf("                           set specific tolerance.\n");
+ printf("   --exclude-path \"path\"   Exclude the specified path to an object when\n");
+ printf("                           comparing files or groups. If a group is excluded,\n");
+ printf("                           all member objects will also be excluded.\n");
+ printf("                           The specified path is excluded wherever it occurs.\n");
+ printf("                           This flexibility enables the same option to exclude\n");
+ printf("                           either objects that exist only in one file or\n");
+ printf("                           common objects that are known to differ.\n");
+ printf("\n");
+ printf("                           When comparing files, \"path\" is the absolute path to\n");
+ printf("                           the excluded object; when comparing groups, \"path\" is\n");
+ printf("                           similar to the relative path from the group to the\n");
+ printf("                           excluded object. This \"path\" can be taken from the\n");
+ printf("                           first section of the output of the --verbose option.\n");
+ printf("                           For example, if you are comparing the group /groupA\n");
+ printf("                           in two files and you want to exclude\n");
+ printf("                           /groupA/groupB/groupC in both files, the exclude\n");
+ printf("                           option would read as follows:\n");
+ printf("                             --exclude-path \"/groupB/groupC\"\n");
+ printf("\n");
+ printf("                           If there are multiple paths to an object, only the\n");
+ printf("                           specified path(s) will be excluded; the comparison\n");
+ printf("                           will include any path not explicitly excluded.\n");
+ printf("                           This option can be used repeatedly to exclude\n");
+ printf("                           multiple paths.\n");
  printf("\n");
 
  printf(" Modes of output:\n");