Misc doc improvements

[git.git] / Documentation / git-apply.txt

diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
index 6702a18..2ff7494 100644 (file)
--- a/Documentation/git-apply.txt
+++ b/Documentation/git-apply.txt
@@ -8,7 +8,11 @@ git-apply - Apply patch on a git index file and a work tree
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] [--apply] [--no-add] [--index-info] [-z] [<patch>...]
+[verse]
+'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] [--apply]
+         [--no-add] [--index-info] [--allow-binary-replacement] [-z] [-pNUM]
+         [-CNUM] [--whitespace=<nowarn|warn|error|error-all|strip>]
+         [<patch>...]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -65,6 +69,16 @@ OPTIONS
        backslash characters replaced with `\t`, `\n`, and `\\`,
        respectively.
 
        backslash characters replaced with `\t`, `\n`, and `\\`,
        respectively.
 

+-p<n>::
+       Remove <n> leading slashes from traditional diff paths. The
+       default is 1.
+
+-C<n>::
+       Ensure at least <n> lines of surrounding context match before
+       and after each change.  When fewer lines of surrounding
+       context exist they all must match.  By default no context is
+       ever ignored.
+

 --apply::
        If you use any of the options marked ``Turns off
        "apply"'' above, git-apply reads and outputs the
 --apply::
        If you use any of the options marked ``Turns off
        "apply"'' above, git-apply reads and outputs the


@@ -79,6 +93,46 @@ OPTIONS
        the result with this option, which would apply the
        deletion part but not addition part.
 
        the result with this option, which would apply the
        deletion part but not addition part.
 

+--allow-binary-replacement::
+       When applying a patch, which is a git-enhanced patch
+       that was prepared to record the pre- and post-image object
+       name in full, and the path being patched exactly matches
+       the object the patch applies to (i.e. "index" line's
+       pre-image object name is what is in the working tree),
+       and the post-image object is available in the object
+       database, use the post-image object as the patch
+       result.  This allows binary files to be patched in a
+       very limited way.
+
+--whitespace=<option>::
+       When applying a patch, detect a new or modified line
+       that ends with trailing whitespaces (this includes a
+       line that solely consists of whitespaces).  By default,
+       the command outputs warning messages and applies the
+       patch.
+       When `git-apply` is used for statistics and not applying a
+       patch, it defaults to `nowarn`.
+       You can use different `<option>` to control this
+       behavior:
++
+* `nowarn` turns off the trailing whitespace warning.
+* `warn` outputs warnings for a few such errors, but applies the
+  patch (default).
+* `error` outputs warnings for a few such errors, and refuses
+  to apply the patch.
+* `error-all` is similar to `error` but shows all errors.
+* `strip` outputs warnings for a few such errors, strips out the
+  trailing whitespaces and applies the patch.
+
+
+Configuration
+-------------
+
+apply.whitespace::
+       When no `--whitespace` flag is given from the command
+       line, this configuration item is used as the default.
+
+

 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>