diff options
| author | Jonathan Nieder <jrnieder@uchicago.edu> | 2008-06-30 01:09:04 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-07-01 17:20:15 -0700 |
| commit | b1889c36d85514e5e70462294c561a02c2edfe2b (patch) | |
| tree | 9a171d7e3fb8063c239a2c9c4dcec744a202de07 /Documentation/git-rm.txt | |
| parent | 46e56e81b3bc91af7071809fbda8dcdec22c4cb1 (diff) | |
| download | git-b1889c36d85514e5e70462294c561a02c2edfe2b.tar.gz git-b1889c36d85514e5e70462294c561a02c2edfe2b.tar.xz | |
Documentation: be consistent about "git-" versus "git "
Since the git-* commands are not installed in $(bindir), using
"git-command <parameters>" in examples in the documentation is
not a good idea. On the other hand, it is nice to be able to
refer to each command using one hyphenated word. (There is no
escaping it, anyway: man page names cannot have spaces in them.)
This patch retains the dash in naming an operation, command,
program, process, or action. Complete command lines that can
be entered at a shell (i.e., without options omitted) are
made to use the dashless form.
The changes consist only of replacing some spaces with hyphens
and vice versa. After a "s/ /-/g", the unpatched and patched
versions are identical.
Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-rm.txt')
| -rw-r--r-- | Documentation/git-rm.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt index d88554bed..41e00d9a6 100644 --- a/Documentation/git-rm.txt +++ b/Documentation/git-rm.txt @@ -7,12 +7,12 @@ git-rm - Remove files from the working tree and from the index SYNOPSIS -------- -'git-rm' [-f] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] <file>... +'git rm' [-f] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] <file>... DESCRIPTION ----------- Remove files from the index, or from the working tree and the index. -`git rm` will not remove a file from just your working directory. +`git-rm` will not remove a file from just your working directory. (There is no option to remove a file only from the work tree and yet keep it in the index; use `/bin/rm` if you want to do that.) The files being removed have to be identical to the tip of the branch, @@ -82,7 +82,7 @@ also remove all of directory `d2`. EXAMPLES -------- -git-rm Documentation/\\*.txt:: +git rm Documentation/\\*.txt:: Removes all `\*.txt` files from the index that are under the `Documentation` directory and any of its subdirectories. + @@ -90,7 +90,7 @@ Note that the asterisk `\*` is quoted from the shell in this example; this lets git, and not the shell, expand the pathnames of files and subdirectories under the `Documentation/` directory. -git-rm -f git-*.sh:: +git rm -f git-*.sh:: 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`. |