commit 4f331d3ae1d21cfb36f682ba698045694212861f
from: Stefan Sperling <stsp@stsp.name>
date: Wed Apr 01 08:11:09 2020 UTC

in got.1, clarify how 'got update' deals with local (aka uncommitted) changes

commit - 40b88b0fdad04965a96ae64b68dc3bfdd21a4ae9
commit + 4f331d3ae1d21cfb36f682ba698045694212861f
blob - 99bf3e8ae0503062b3ca312d1f3880d3861a5bf7
blob + 8ddf308d330434ad216a06a2b988a0b906abe96c
--- got/got.1
+++ got/got.1
@@ -513,7 +513,13 @@ will be checked out.
 Short alias for
 .Cm checkout .
 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
-Update an existing work tree to a different commit.
+Update an existing work tree to a different
+.Ar commit .
+Change existing files in the work tree as necessary to match file contents
+of this commit.
+Preserve any local changes in the work tree and merge them with the
+incoming changes.
+.Pp
 Show the status of each affected file, using the following status codes:
 .Bl -column YXZ description
 .It U Ta file was updated and contained no local changes
@@ -564,6 +570,18 @@ Switch the work tree's branch reference to the specifi
 .Ar branch
 before updating the work tree.
 This option requires that all paths in the work tree are updated.
+.Pp
+As usual, any local changes in the work tree will be preserved.
+This can be useful when switching to a newly created branch in order
+to commit existing local changes to this branch.
+.Pp
+Any local changes must be dealt with separately in order to obtain a
+work tree with pristine file contents corresponding exactly to the specified
+.Ar branch .
+Such changes could first be committed to a different branch with
+.Cm got commit ,
+or could be discarded with
+.Cm got revert .
 .It Fl c Ar commit
 Update the work tree to the specified
 .Ar commit .