chiark / gitweb /
git-debrebase: Add some plans for future, in a comment
[dgit.git] / git-debrebase.1.pod
index 5da532029049951d43682eed5671df153e3e75e1..4d4c85a94992b7e83f68d5e8a20212176ee658c6 100644 (file)
@@ -55,6 +55,19 @@ The options for git-rebase must either start with C<-i>,
 or be prececded by C<-->,
 to distinguish them from options for git-debrebase.
 
+=item git-debrebase status
+
+Analyise the current branch,
+both in terms of its conents,
+and the refs which are relevant to git-debrebase,
+and print a human-readable summary.
+
+Please do not attempt to parse the output;
+it may be reformatted or reorganised in the future.
+Instead,
+use one of the L<UNDERLYING AND SUPPLEMENTARY OPERATIONS>
+described below.
+
 =item git-debrebase conclude
 
 Finishes a git-debrebase session,
@@ -188,7 +201,7 @@ that its command line syntax is optimal.
 We may want to introduce an incompatible replacement syntax
 under the name C<new-upstream>.
 
-=item git-debrebase make-patches
+=item git-debrebase make-patches [--quiet-would-amend]
 
 Generate patches in debian/patches/
 representing the changes made to upstream files.
@@ -209,6 +222,12 @@ and all that has happened is that more
 changes to upstream files have been committed,
 running it again can add the missing patches.
 
+If the patches implied by the current branch
+are not a simple superset of those already in debian/patches,
+make-patches will fail with exit status 7,
+and an error message.
+(The message can be suppress with --quiet-would-amend.)
+
 =item git-debrebase convert-from-gbp [<upstream-commit-ish>]
 
 Cnnverts a gbp patches-unapplied branch