chiark / gitweb /
git-debrebase(1): document record-ffq-prev
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Mon, 19 Feb 2018 01:25:45 +0000 (01:25 +0000)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Sat, 16 Jun 2018 15:07:00 +0000 (16:07 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
NOTES.git-debrebase
git-debrebase
git-debrebase.1.pod

index 5a6ff88..7b9a9b1 100644 (file)
@@ -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
index 066f422..75a8f51 100755 (executable)
@@ -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
 
index 0127e93..cd52c8c 100644 (file)
@@ -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.