[PATCH v2 14/15] user-manual: Flesh out uncommitted changes and submodule updates

From: W. Trevor King <wking@tremily.us>
Date: Feb 10, 2013, 15:10 UTC
Message-ID: <99c30216d8f4365e34ed71b7cf3670b0e31bc89e.1360508415.git.wking@tremily.us>
In-Reply-To: <cover.1360508415.git.wking@tremily.us>

From: "W. Trevor King" <wking@tremily.us>

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>
---
 Documentation/user-manual.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index dbd0143..8024758 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -3751,7 +3751,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 did not commit your submodule changes, the changes will *not*
+be silently overwritten.  Instead, you get the usual warning about not
+being able switch from a dirty branch.
 
 [[low-level-operations]]
 Low-level Git operations

-- 
1.8.1.336.g94702dd