resolve_gitlink_ref_recursive(): change to work with struct ref_cache
[gitweb.git] / Documentation / git-apply.txt
index c2528a76545a154eb42a430b59caf26e7aad3bef..afd2c9ae59e9145f377d5c702df27bf861c9b2f5 100644 (file)
@@ -12,20 +12,24 @@ SYNOPSIS
 'git apply' [--stat] [--numstat] [--summary] [--check] [--index]
          [--apply] [--no-add] [--build-fake-ancestor=<file>] [-R | --reverse]
          [--allow-binary-replacement | --binary] [--reject] [-z]
-         [-pNUM] [-CNUM] [--inaccurate-eof] [--recount] [--cached]
+         [-p<n>] [-C<n>] [--inaccurate-eof] [--recount] [--cached]
          [--ignore-space-change | --ignore-whitespace ]
-         [--whitespace=<nowarn|warn|fix|error|error-all>]
-         [--exclude=PATH] [--include=PATH] [--directory=<root>]
+         [--whitespace=(nowarn|warn|fix|error|error-all)]
+         [--exclude=<path>] [--include=<path>] [--directory=<root>]
          [--verbose] [<patch>...]
 
 DESCRIPTION
 -----------
 Reads the supplied diff output (i.e. "a patch") and applies it to files.
 With the `--index` option the patch is also applied to the index, and
-with the `--cache` option the patch is only applied to the index.
+with the `--cached` option the patch is only applied to the index.
 Without these options, the command applies the patch only to files,
 and does not require them to be in a git repository.
 
+This command applies the patch but does not create a commit.  Use
+linkgit:git-am[1] to create commits from patches generated by
+linkgit:git-format-patch[1] and/or received by email.
+
 OPTIONS
 -------
 <patch>...::
@@ -69,7 +73,7 @@ OPTIONS
        without using the working tree. This implies `--index`.
 
 --build-fake-ancestor=<file>::
-       Newer 'git-diff' output has embedded 'index information'
+       Newer 'git diff' output has embedded 'index information'
        for each blob to help identify the original version that
        the patch applies to.  When this flag is given, and if
        the original versions of the blobs are available locally,
@@ -83,7 +87,7 @@ the information is read from the current index instead.
        Apply the patch in reverse.
 
 --reject::
-       For atomicity, 'git-apply' by default fails the whole patch and
+       For atomicity, 'git apply' by default fails the whole patch and
        does not touch the working tree when some of the hunks
        do not apply.  This option makes it apply
        the parts of the patch that are applicable, and leave the
@@ -109,7 +113,7 @@ any of those replacements occurred.
        ever ignored.
 
 --unidiff-zero::
-       By default, 'git-apply' expects that the patch being
+       By default, 'git apply' expects that the patch being
        applied is a unified diff with at least one line of context.
        This provides good safety measures, but breaks down when
        applying a diff generated with `--unified=0`. To bypass these
@@ -120,7 +124,7 @@ discouraged.
 
 --apply::
        If you use any of the options marked "Turns off
-       'apply'" above, 'git-apply' reads and outputs the
+       'apply'" above, 'git apply' reads and outputs the
        requested information without actually applying the
        patch.  Give this flag after those flags to also apply
        the patch.
@@ -229,7 +233,7 @@ apply.whitespace::
 
 Submodules
 ----------
-If the patch contains any changes to submodules then 'git-apply'
+If the patch contains any changes to submodules then 'git apply'
 treats these changes as follows.
 
 If `--index` is specified (explicitly or implicitly), then the submodule
@@ -242,13 +246,9 @@ If `--index` is not specified, then the submodule commits in the patch
 are ignored and only the absence or presence of the corresponding
 subdirectory is checked and (if possible) updated.
 
-Author
-------
-Written by Linus Torvalds <torvalds@osdl.org>
-
-Documentation
---------------
-Documentation by Junio C Hamano
+SEE ALSO
+--------
+linkgit:git-am[1].
 
 GIT
 ---