git-debrebase(1): document record-ffq-prev

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

3 files changed, 11 insertions, 5 deletions

diff --git a/NOTES.git-debrebase b/NOTES.git-debrebase
index 5a6ff88..7b9a9b1 100644
--- a/NOTES.git-debrebase
+++ b/NOTES.git-debrebase
@@ -84,10 +84,6 @@ We check we are ff from remotes before recording new ffq-prev
 
   ---------- now follows much the same info in different words ----------
 
-N. git-debrebase [--noop-ok] record-ffq-prev
-
-     does what is described above
-
 Re git-debrebase [--noop-ok] stitch
 
     we will teach dgit to do
diff --git a/git-debrebase b/git-debrebase
index 066f422..75a8f51 100755
--- a/git-debrebase
+++ b/git-debrebase
@@ -19,7 +19,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-# usages:
+# undocumented usages:
 #
 #    git-debrebase [<options>] downstream-rebase-launder-v0  # experimental
 
diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod
index 0127e93..cd52c8c 100644
--- a/git-debrebase.1.pod
+++ b/git-debrebase.1.pod
@@ -208,6 +208,16 @@ and commit type and info
 (ie the semantics in the git-debrebase model)
 for each commit.
 
+=item git-debrebase record-ffq-prev
+
+Establishes the current branch's ffq-prev,
+as discussed in L</UNSTITCHING AND LAUNDERING>,
+but does not launder the branch or move HEAD.
+
+It is an error if the ffq-prev could not be recorded.
+It is also an error if an ffq-prev has already been recorded,
+unless --noop-ok.
+
 =item git-debrebase launder-v0
 
 Launders the branch without recording anything in ffq-prev.