X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-apply.txt;h=4c7e3a2f7f5d542cd95059430f53143bba59fc7f;hb=04222b245c5e0d49242ef1ca995fadd5fa082cd3;hp=3bd2c995da7d65977481837486dc15e5e96baf91;hpb=53a58245863eff3d70aaa3ac75d7d57e843fc91d;p=git.git

diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
index 3bd2c995d..4c7e3a2f7 100644
--- a/Documentation/git-apply.txt
+++ b/Documentation/git-apply.txt
@@ -171,6 +171,20 @@ apply.whitespace::
 	When no `--whitespace` flag is given from the command
 	line, this configuration item is used as the default.
 
+Submodules
+----------
+If the patch contains any changes to submodules then gitlink:git-apply[1]
+treats these changes as follows.
+
+If --index is specified (explicitly or implicitly), then the submodule
+commits must match the index exactly for the patch to apply.  If any
+of the submodules are checked-out, then these check-outs are completely
+ignored, i.e., they are not required to be up-to-date or clean and they
+are not updated.
+
+If --index is not specified, then the submodule commits in the patch
+are ignored and only the absence of presence of the corresponding
+subdirectory is checked and (if possible) updated.
 
 Author
 ------
@@ -183,4 +197,3 @@ Documentation by Junio C Hamano
 GIT
 ---
 Part of the gitlink:git[7] suite
-