Commit 6e54d307ad19628df87baec4835b0c8c4f9955c5

Stefan Sperling 2020-02-24T21:03:20

document more clearly what needs to be done to start a histedit operation

diff --git a/got/got.1 b/got/got.1
index 60da95a..465fc51 100644
--- a/got/got.1
+++ b/got/got.1
@@ -1016,6 +1016,26 @@ Short alias for
 Edit commit history between the work tree's current base commit and
 the tip commit of the work tree's current branch.
 .Pp
+Before starting a
+.Cm histedit
+operation the work tree's current branch must be set with
+.Cm got update -b
+to the branch which should be edited, unless this branch is already the
+current branch of the work tree.
+The tip of this branch represents the upper bound (inclusive) of commits
+touched by the
+.Cm histedit
+operation.
+.Pp
+Furthermore, the work tree's base commit
+must be set with
+.Cm got update -c
+to a point in this branch's commit history where editing should begin.
+This commit represents the lower bound (non-inclusive) of commits touched
+by the
+.Cm histedit
+operation.
+.Pp
 Editing of commit history is controlled via a
 .Ar histedit script
 which can be edited interactively, passed on the command line,