commit 6e54d307ad19628df87baec4835b0c8c4f9955c5
from: Stefan Sperling <stsp@stsp.name>
date: Mon Feb 24 21:03:20 2020 UTC

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

commit - 80106605fef38d5bd94de493c3aa9ccdbcb9c8f8
commit + 6e54d307ad19628df87baec4835b0c8c4f9955c5
blob - 60da95afedf6b34f6eba7c8f546b7bad802dfa6b
blob + 465fc51b44976a4da51c9c6afeb908d2fef79aff
--- got/got.1
+++ got/got.1
@@ -1015,7 +1015,27 @@ Short alias for
 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
 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,