Skip to content

Commit

Permalink
git-rm documentation: remove broken behaviour from the example.
Browse files Browse the repository at this point in the history
The example section were talking about the old broken default
behaviour.  Correct it.

Signed-off-by: Junio C Hamano <junkio@cox.net>
  • Loading branch information
Junio C Hamano committed Jan 16, 2007
1 parent dc36f26 commit a9877f8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 9 deletions.
12 changes: 4 additions & 8 deletions Documentation/git-rm.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,21 +60,17 @@ a file that you have not told git about does not remove that file.
EXAMPLES
--------
git-rm Documentation/\\*.txt::

Removes all `\*.txt` files from the index that are under the
`Documentation` directory and any of its subdirectories. The
files are not removed from the working tree.
`Documentation` directory and any of its subdirectories.
+
Note that the asterisk `\*` is quoted from the shell in this
example; this lets the command include the files from
subdirectories of `Documentation/` directory.

git-rm -f git-*.sh::

Remove all git-*.sh scripts that are in the index. The files
are removed from the index, and from the working
tree. Because this example lets the shell expand the
asterisk (i.e. you are listing the files explicitly), it
Remove all git-*.sh scripts that are in the index.
Because this example lets the shell expand the asterisk
(i.e. you are listing the files explicitly), it
does not remove `subdir/git-foo.sh`.

See Also
Expand Down
2 changes: 1 addition & 1 deletion builtin-rm.c
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#include "tree-walk.h"

static const char builtin_rm_usage[] =
"git-rm [-n] [-f] [--cached] <filepattern>...";
"git-rm [-f] [-n] [-r] [--cached] [--] <file>...";

static struct {
int nr, alloc;
Expand Down

0 comments on commit a9877f8

Please sign in to comment.