Commit cfce0458c9dc348a48d88137318ce86f76dc7766

Stefan Sperling 2019-07-28T12:08:25

document 'got commit' out-of-dateness check

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
diff --git a/got/got.1 b/got/got.1
index 035a4e6..5de835a 100644
--- a/got/got.1
+++ b/got/got.1
@@ -519,6 +519,15 @@ option,
 .Cm got commit
 opens a temporary file in an editor where a log message can be written.
 .El
+.Pp
+.Cm got commit
+will refuse to run if certain preconditions are not met.
+Local changes may only be committed if they are based on file content
+found in the most recent commit on the work tree's branch.
+If a path is found to be out of date,
+.Cm got update
+must be used first in order to merge local changes with changes made
+in the repository.
 .It Cm ci
 Short alias for
 .Cm commit .