index: Correct inconsitency in documentation of modes

In the optspec, --clear and --check are documented as being modes, but
in the man page they are simple options.

Also, even though --clear and --check are listed as modes in the
optspec, they don't appear in the synopsis line.

According to the code, --clear and --check do behave as modes so we
should be consistent in how we document them.

Signed-off-by: Gabriel Filion <gabster@lelutin.ca>
Reviewed-by: Rob Browning <rlb@defaultvalue.org>
Tested-by: Rob Browning <rlb@defaultvalue.org>

diff --git a/Documentation/bup-index.md b/Documentation/bup-index.md
index 280d9eb1d4fe361fc124eb07fceda9573c9f3f4c..d85d17969b2d82bef736199aeac9fd60e33ffe64 100644 (file)
--- a/Documentation/bup-index.md
+++ b/Documentation/bup-index.md
@@ -8,8 +8,8 @@ bup-index - print and/or update the bup filesystem index
 
 # SYNOPSIS
 
-bup index \<-p|-m|-s|-u\> [-H] [-l] [-x] [\--fake-valid] [\--no-check-device]
-[\--fake-invalid] [\--check] [\--clear] [-f *indexfile*] [\--exclude *path*]
+bup index \<-p|-m|-s|-u|\--clear|\--check\> [-H] [-l] [-x] [\--fake-valid]
+[\--no-check-device] [\--fake-invalid] [-f *indexfile*] [\--exclude *path*]
 [\--exclude-from *filename*] [\--exclude-rx *pattern*]
 [\--exclude-rx-from *filename*] [-v] \<filenames...\>
 
@@ -110,7 +110,14 @@ does, due to the accommodations described above.
     filename.  Implies `-p`.  The codes mean, respectively,
     that a file is marked in the index as added, modified,
     deleted, or unchanged since the last backup.
-    
+
+\--check
+:   carefully check index file integrity before and after
+    updating.  Mostly useful for automated tests.
+
+\--clear
+:   clear the default index.
+
 
 # OPTIONS
 
@@ -144,13 +151,6 @@ does, due to the accommodations described above.
 \--fake-invalid
 :   mark specified filenames as not up-to-date, forcing the
     next "bup save" run to re-check their contents.
-    
-\--check
-:   carefully check index file integrity before and after
-    updating.  Mostly useful for automated tests.
-
-\--clear
-:   clear the default index.
 
 -f, \--indexfile=*indexfile*
 :   use a different index filename instead of

diff --git a/cmd/index-cmd.py b/cmd/index-cmd.py
index b7fe8f1323a74b20e2cc9aebe4f00cd7ff9b4e86..6f2adf4e581c1dc288babe4bee3525c2f61ea004 100755 (executable)
--- a/cmd/index-cmd.py
+++ b/cmd/index-cmd.py
@@ -185,7 +185,7 @@ def update_index(top, excluded_paths, exclude_rxs):
 
 
 optspec = """
-bup index <-p|m|s|u> [options...] <filenames...>
+bup index <-p|-m|-s|-u|--clear|--check> [options...] <filenames...>
 --
  Modes:
 p,print    print the index entries for the given names (also works with -u)