Commit f2cf8fbb2f991890d446eb5f7b566b2c8312333c

Stefan Sperling 2019-04-04T17:12:02

improve partial update documentation

diff --git a/got/got.1 b/got/got.1
index 83aee65..5d3d48a 100644
--- a/got/got.1
+++ b/got/got.1
@@ -103,11 +103,15 @@ Show the status of each affected file, using the following status codes:
 If a
 .Ar path
 is specified, restrict the update operation to files at or within this path.
-Files outside this path will remain at their currently recorded base commit.
-Some operations may refuse to run while the work tree contains files from
+The path is required to exist in the update operation's target commit.
+Files in the work tree outside this path will remain unchanged and will
+retain their previously recorded base commit.
+Some
+.Nm
+commands may refuse to run while the work tree contains files from
 multiple base commits.
-Inconsistent base commits in a work tree can be repaired by running another
-update operation across the entire work tree.
+The base commit of such a work tree can be made consistent by running
+another update operation across the entire work tree.
 .Pp
 The options for
 .Cm got update