From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Mon, 19 Feb 2018 01:25:45 +0000 (+0000)
Subject: git-debrebase(1): document record-ffq-prev
X-Git-Tag: archive/debian/5.0~106
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=commitdiff_plain;h=67db3561da79c090d84228d06adb11546881bba8

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

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

diff --git a/NOTES.git-debrebase b/NOTES.git-debrebase
index 5a6ff882..7b9a9b19 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 066f4222..75a8f51a 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 0127e93d..cd52c8c1 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.