From 522e4781fb0d4129689953b76072dba2ef91854b Mon Sep 17 00:00:00 2001 From: Gabriel Filion Date: Wed, 19 Nov 2014 12:30:07 -0500 Subject: [PATCH] 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 Reviewed-by: Rob Browning Tested-by: Rob Browning --- Documentation/bup-index.md | 20 ++++++++++---------- cmd/index-cmd.py | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/Documentation/bup-index.md b/Documentation/bup-index.md index 280d9eb..d85d179 100644 --- 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] \ @@ -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 b7fe8f1..6f2adf4 100755 --- 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...] +bup index <-p|-m|-s|-u|--clear|--check> [options...] -- Modes: p,print print the index entries for the given names (also works with -u) -- 2.39.2