diff options
| author |  W. Trevor King <wking@tremily.us> | 2013-02-19 05:05:02 -0500 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2013-02-19 12:56:30 -0800 |
| commit | 9148673377367db48183a33dcc53c828df397bfc (patch) | |
| tree | df7b54a57c26634110a76daa8cfe7ee0f3b5d918 | |
| parent | user-manual: Use request-pull to generate "please pull" text (diff) | |
| download | tgif-9148673377367db48183a33dcc53c828df397bfc.tar.xz | |
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>
| -rw-r--r-- | Documentation/user-manual.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index acf872d893..bb03bc88b8 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -3739,7 +3739,9 @@ module a NOTE: The changes are still visible in the submodule's reflog. -This is not the case if you did not commit your changes. +If you have uncommitted changes in your submodule working tree, `git +submodule update` will not overwrite them. Instead, you get the usual +warning about not being able switch from a dirty branch. [[low-level-operations]] Low-level git operations |