Make usage documentation for git-add consistent.

PATCH New Brian Hetro 1 participant 1 message Jun 15, 2016 Documentation

Share & tools

Brian Hetro

author

2016-06-15 22:43 UTC #0 lore raw

PATCH 1/1 Make usage documentation for git-add consistent.

The usage string for the executable was missing --refresh. In addition, the documentation referred to "file", but the usage string referred to "filepattern". Updated the documentation to "filepattern", as git-add does handle patterns.

Signed-off-by Brian Hetro <[email protected]>

---
 Documentation/git-add.txt |    6 ++++--
 builtin-add.c             |    2 +-
 2 files changed, 5 insertions(+), 3 deletions(-)

Documentation/git-add.txt +4 -2

index 3383aca..e5efbc9 100644
@@ -7,7 +7,9 @@ git-add - Add file contents to the index
 
 SYNOPSIS
 --------
-'git-add' [-n] [-v] [-f] [--interactive | -i] [-u] [--refresh] [--] <file>...
+[verse]
+'git-add' [-n] [-v] [-f] [--interactive | -i] [-u] [--refresh]
+          [--] <filepattern>...
 
 DESCRIPTION
 -----------

@@ -41,7 +43,7 @@ commit.
 
 OPTIONS
 -------
-<file>...::
+<filepattern>...::
 	Files to add content from.  Fileglobs (e.g. `*.c`) can
 	be given to add all matching files.  Also a
 	leading directory name (e.g. `dir` to add `dir/file1`

builtin-add.c +1 -1

index 3dd4ded..b08e688 100644
@@ -14,7 +14,7 @@
 #include "revision.h"
 
 static const char builtin_add_usage[] =
-"git-add [-n] [-v] [-f] [--interactive | -i] [-u] [--] <filepattern>...";
+"git-add [-n] [-v] [-f] [--interactive | -i] [-u] [--refresh] [--] <filepattern>...";
 
 static int take_worktree_changes;
 static const char *excludes_file;

Signature · 1 line

1.5.3.rc6.23.g0058-dirty