push: add recurseSubmodules config option

[thirdparty/git.git] / Documentation / config.txt

diff --git a/Documentation/config.txt b/Documentation/config.txt
index b4b01948d0c52a42a322ed2cdeb33f475bf08c22..8c02e434833e2b8f270a5fe3d31a07f8848f9dc5 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -2226,6 +2226,20 @@ push.gpgSign::
        override a value from a lower-priority config file. An explicit
        command-line flag always overrides this config option.
 
+push.recurseSubmodules::
+       Make sure all submodule commits used by the revisions to be pushed
+       are available on a remote-tracking branch. If the value is 'check'
+       then Git will verify that all submodule commits that changed in the
+       revisions to be pushed are available on at least one remote of the
+       submodule. If any commits are missing, the push will be aborted and
+       exit with non-zero status. If the value is 'on-demand' then all
+       submodules that changed in the revisions to be pushed will be
+       pushed. If on-demand was not able to push all necessary revisions
+       it will also be aborted and exit with non-zero status. If the value
+       is 'no' then default behavior of ignoring submodules when pushing
+       is retained. You may override this configuration at time of push by
+       specifying '--recurse-submodules=check|on-demand|no'.
+
 rebase.stat::
        Whether to show a diffstat of what changed upstream since the last
        rebase. False by default.