git-apply --directory: make --root more similar to GNU diff

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

diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
index 63fce53690e35f28ebb4db049dec553fd094083f..3cd3179ff17f45ec0c0cbd3687fdf8020cd8e5f4 100644 (file)
--- a/Documentation/git-apply.txt
+++ b/Documentation/git-apply.txt
@@ -14,7 +14,7 @@ SYNOPSIS
          [--allow-binary-replacement | --binary] [--reject] [-z]
          [-pNUM] [-CNUM] [--inaccurate-eof] [--cached]
          [--whitespace=<nowarn|warn|fix|error|error-all>]
-         [--exclude=PATH] [--root=<root>] [--verbose] [<patch>...]
+         [--exclude=PATH] [--directory=<root>] [--verbose] [<patch>...]
 
 DESCRIPTION
 -----------
@@ -177,9 +177,13 @@ behavior:
        current patch being applied will be printed. This option will cause
        additional information to be reported.
 
---root=<root>::
+--directory=<root>::
        Prepend <root> to all filenames.  If a "-p" argument was passed, too,
        it is applied before prepending the new root.
++
+For example, a patch that talks about updating `a/git-gui.sh` to `b/git-gui.sh`
+can be applied to the file in the working tree `modules/git-gui/git-gui.sh` by
+running `git apply --directory=modules/git-gui`.
 
 Configuration
 -------------