mirror of
https://github.com/git/git
synced 2024-08-24 18:26:02 +00:00
doc: rm: synchronize <pathspec> description
This patch continues the effort that is already applied to `git commit`, `git reset`, `git checkout` etc. 1) Changed outdated descriptions to mention pathspec instead. 2) Added reference to 'linkgit:gitglossary[7]'. 3) Removed content that merely repeated gitglossary. 4) Merged the remainder of "discussion" into `<patchspec>`. Signed-off-by: Alexandr Miloslavskiy <alexandr.miloslavskiy@syntevo.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
232378479e
commit
6a7aca6f01
|
@ -8,16 +8,16 @@ git-rm - Remove files from the working tree and from the index
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git rm' [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] <file>...
|
||||
'git rm' [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] <pathspec>...
|
||||
|
||||
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.
|
||||
(There is no option to remove a file only from the working 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,
|
||||
and no updates to their contents can be staged in the index,
|
||||
Remove files matching pathspec from the index, or from the working tree
|
||||
and the index. `git rm` will not remove a file from just your working
|
||||
directory. (There is no option to remove a file only from the working
|
||||
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, and no updates to their contents can be staged in the index,
|
||||
though that default behavior can be overridden with the `-f` option.
|
||||
When `--cached` is given, the staged content has to
|
||||
match either the tip of the branch or the file on disk,
|
||||
|
@ -26,15 +26,20 @@ allowing the file to be removed from just the index.
|
|||
|
||||
OPTIONS
|
||||
-------
|
||||
<file>...::
|
||||
Files to remove. Fileglobs (e.g. `*.c`) can be given to
|
||||
remove all matching files. If you want Git to expand
|
||||
file glob characters, you may need to shell-escape them.
|
||||
A leading directory name
|
||||
(e.g. `dir` to remove `dir/file1` and `dir/file2`) can be
|
||||
given to remove all files in the directory, and recursively
|
||||
all sub-directories,
|
||||
but this requires the `-r` option to be explicitly given.
|
||||
<pathspec>...::
|
||||
Files to remove. A leading directory name (e.g. `dir` to remove
|
||||
`dir/file1` and `dir/file2`) can be given to remove all files in
|
||||
the directory, and recursively all sub-directories, but this
|
||||
requires the `-r` option to be explicitly given.
|
||||
+
|
||||
The command removes only the paths that are known to Git.
|
||||
+
|
||||
File globbing matches across directory boundaries. Thus, given two
|
||||
directories `d` and `d2`, there is a difference between using
|
||||
`git rm 'd*'` and `git rm 'd/*'`, as the former will also remove all
|
||||
of directory `d2`.
|
||||
+
|
||||
For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
|
||||
|
||||
-f::
|
||||
--force::
|
||||
|
@ -69,19 +74,6 @@ OPTIONS
|
|||
for each file removed. This option suppresses that output.
|
||||
|
||||
|
||||
DISCUSSION
|
||||
----------
|
||||
|
||||
The <file> list given to the command can be exact pathnames,
|
||||
file glob patterns, or leading directory names. The command
|
||||
removes only the paths that are known to Git. Giving the name of
|
||||
a file that you have not told Git about does not remove that file.
|
||||
|
||||
File globbing matches across directory boundaries. Thus, given
|
||||
two directories `d` and `d2`, there is a difference between
|
||||
using `git rm 'd*'` and `git rm 'd/*'`, as the former will
|
||||
also remove all of directory `d2`.
|
||||
|
||||
REMOVING FILES THAT HAVE DISAPPEARED FROM THE FILESYSTEM
|
||||
--------------------------------------------------------
|
||||
There is no option for `git rm` to remove from the index only
|
||||
|
|
Loading…
Reference in a new issue