user-manual: Flesh out uncommitted changes and submodule updates
If you try and update a submodule with a dirty working directory, you get an error message like: $ git submodule update error: Your local changes to the following files would be overwritten by checkout: ... Please, commit your changes or stash them before you can switch branches. Aborting ... Mention this in the submodule notes. The previous phrase was short enough that I originally thought it might have been referring to the reflog note (obviously, uncommitted changes will not show up in the reflog either ;). Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
W. Trevor King committed
Feb 19, 2013 at 05:05 UTC
9148673377367db48183a33dcc53c828df397bfc
1 file changed
+3
-1
Documentation/user-manual.txt
+3
-1
@@ -3739,7 +3739,9 @@ module a
3739
3740
NOTE: The changes are still visible in the submodule's reflog.
3741
3742
-This is not the case if you did not commit your changes.
3742
+If you have uncommitted changes in your submodule working tree, `git
3743
+submodule update` will not overwrite them. Instead, you get the usual
3744
+warning about not being able switch from a dirty branch.
3745
3746
[[low-level-operations]]
3747
Low-level git operations