Documentation / git-rm.txton commit revision.c: explain what tree_difference does (0a4ba7f)
   1git-rm(1)
   2=========
   3
   4NAME
   5----
   6git-rm - Remove files from the working tree and from the index
   7
   8SYNOPSIS
   9--------
  10'git-rm' [-f] [-n] [-r] [--cached] [--] <file>...
  11
  12DESCRIPTION
  13-----------
  14Remove files from the working tree and from the index.  The
  15files have to be identical to the tip of the branch, and no
  16updates to its contents must have been placed in the staging
  17area (aka index).
  18
  19
  20OPTIONS
  21-------
  22<file>...::
  23        Files to remove.  Fileglobs (e.g. `*.c`) can be given to
  24        remove all matching files.  Also a leading directory name
  25        (e.g. `dir` to add `dir/file1` and `dir/file2`) can be
  26        given to remove all files in the directory, recursively,
  27        but this requires `-r` option to be given for safety.
  28
  29-f::
  30        Override the up-to-date check.
  31
  32-n::
  33        Don't actually remove the file(s), just show if they exist in
  34        the index.
  35
  36-r::
  37        Allow recursive removal when a leading directory name is
  38        given.
  39
  40\--::
  41        This option can be used to separate command-line options from
  42        the list of files, (useful when filenames might be mistaken
  43        for command-line options).
  44
  45\--cached::
  46        This option can be used to tell the command to remove
  47        the paths only from the index, leaving working tree
  48        files.
  49
  50
  51DISCUSSION
  52----------
  53
  54The list of <file> given to the command can be exact pathnames,
  55file glob patterns, or leading directory name.  The command
  56removes only the paths that is known to git.  Giving the name of
  57a file that you have not told git about does not remove that file.
  58
  59
  60EXAMPLES
  61--------
  62git-rm Documentation/\\*.txt::
  63        Removes all `\*.txt` files from the index that are under the
  64        `Documentation` directory and any of its subdirectories.
  65+
  66Note that the asterisk `\*` is quoted from the shell in this
  67example; this lets the command include the files from
  68subdirectories of `Documentation/` directory.
  69
  70git-rm -f git-*.sh::
  71        Remove all git-*.sh scripts that are in the index.
  72        Because this example lets the shell expand the asterisk
  73        (i.e. you are listing the files explicitly), it
  74        does not remove `subdir/git-foo.sh`.
  75
  76See Also
  77--------
  78gitlink:git-add[1]
  79
  80Author
  81------
  82Written by Linus Torvalds <torvalds@osdl.org>
  83
  84Documentation
  85--------------
  86Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
  87
  88GIT
  89---
  90Part of the gitlink:git[7] suite
  91