chiark / gitweb /
git-debrebase: factor out getoptions for subcommand
[dgit.git] / git-debrebase
index 7b2e4f311dfbdf64813d14cb2bac92184837a6ff..907ebfeb755e0c3b00613f502266f7e8d154bda2 100755 (executable)
@@ -36,6 +36,18 @@ use Dpkg::Version;
 use File::FnMatch qw(:fnmatch);
 use File::Copy;
 
+our ($usage_message) = <<'END';
+usages:
+  git-debrebase [<options>] [--|-i <git rebase options...>]
+  git-debrebase [<options>] status
+  git-debrebase [<options>] prepush [--prose=...]
+  git-debrebase [<options>] quick|conclude
+  git-debrebase [<options>] new-upstream <new-version> [<details ...>]
+  git-debrebase [<options>] convert-from-gbp [<upstream-commitish>]
+  ...
+See git-debrebase(1), git-debrebase(5), dgit-maint-debrebase(7) (in dgit).
+END
+
 our ($opt_force, $opt_noop_ok, @opt_anchors);
 our ($opt_defaultcmd_interactive);
 
@@ -45,10 +57,20 @@ $|=1;
 
 sub badusage ($) {
     my ($m) = @_;
-    print STDERR "bad usage: $m\n";
+    print STDERR "$us: bad usage: $m\n";
     finish 8;
 }
 
+sub getoptions_main {
+    my $m = shift;
+    local $SIG{__WARN__}; # GetOptions calls `warn' to print messages
+    GetOptions @_ or badusage $m;
+}
+sub getoptions {
+    my $sc = shift;
+    getoptions_main "bad options follow \`git-debrebase $sc'", @_;
+}
+
 sub cfg ($;$) {
     my ($k, $optional) = @_;
     local $/ = "\0";
@@ -573,7 +595,7 @@ sub keycommits ($;$$$$) {
     my ($anchor, $breakwater);
     my $clogonly;
     my $cl;
-    $fatal //= sub { fail $_[2]; };
+    $fatal //= sub { fail $_[1]; };
     my $x = sub {
        my ($cb, $tagsfx, $mainwhy, $xwhy) = @_;
        my $why = $mainwhy.$xwhy;
@@ -679,10 +701,11 @@ sub walk ($;$$) {
        if ($nogenerate) {
            return (undef,undef);
        }
-       die "commit $cur: Cannot cope with this commit (d.".
+       fail "found unprocessable commit, cannot cope:".
+           (defined $cl->{Why} ? "; $cl->{Why}": '').
+           " (commit $cur) (d.".
            (join ' ', map { sprintf "%#x", $_->{Differs} }
             @{ $cl->{Parents} }).
-           (defined $cl->{Why} ? "; $cl->{Why}": '').
                 ")";
     };
 
@@ -970,7 +993,8 @@ sub defaultcmd_rebase () {
 }
 
 sub cmd_analyse () {
-    die if ($ARGV[0]//'') =~ m/^-/;
+    badusage "analyse does not support any options"
+       if @ARGV and $ARGV[0] =~ m/^-/;
     badusage "too many arguments to analyse" if @ARGV>1;
     my ($old) = @ARGV;
     if (defined $old) {
@@ -1160,23 +1184,12 @@ sub do_stitch ($;$) {
     stitch($dangling_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose);
 }
 
-sub cmd_new_upstream () {
-    # automatically and unconditionally launders before rebasing
-    # if rebase --abort is used, laundering has still been done
-
-    my %pieces;
-
-    badusage "need NEW-VERSION [UPS-COMMITTISH]" unless @ARGV >= 1;
+sub resolve_upstream_version ($$) {
+    my ($new_upstream, $version) = @_;
 
-    # parse args - low commitment
-    my $spec_version = shift @ARGV;
-    my $new_version = (new Dpkg::Version $spec_version, check => 1);
-    if ($new_version->is_native()) {
-       $new_version = (new Dpkg::Version "$spec_version-1", check => 1);
-    }
-    my $new_upstream_version = $new_version->version();
+    my $new_upstream_version = "$version";
+    $new_upstream_version =~ s/-.*?$//;;
 
-    my $new_upstream = shift @ARGV;
     if (!defined $new_upstream) {
        my @tried;
        # todo: at some point maybe use git-deborig to do this
@@ -1194,6 +1207,30 @@ sub cmd_new_upstream () {
     }
     $new_upstream = git_rev_parse $new_upstream;
 
+    return ($new_upstream, $new_upstream_version);
+}
+
+sub cmd_new_upstream () {
+    # automatically and unconditionally launders before rebasing
+    # if rebase --abort is used, laundering has still been done
+
+    my %pieces;
+
+    badusage "need NEW-VERSION [UPS-COMMITTISH]" unless @ARGV >= 1;
+
+    # parse args - low commitment
+    my $spec_version = shift @ARGV;
+    my $new_version = (new Dpkg::Version $spec_version, check => 1);
+    fail "bad version number \`$spec_version'" unless defined $new_version;
+    if ($new_version->is_native()) {
+       $new_version = (new Dpkg::Version "$spec_version-1", check => 1);
+    }
+
+    my $new_upstream = shift @ARGV;
+    my $new_upstream_version;
+    ($new_upstream, $new_upstream_version) =
+       resolve_upstream_version $new_upstream, $new_version;
+
     record_ffq_auto();
 
     my $piece = sub {
@@ -1503,7 +1540,8 @@ sub cmd_status () {
 
 sub cmd_stitch () {
     my $prose = 'stitch';
-    GetOptions('prose=s', \$prose) or badusage("bad options to stitch");
+    getoptions("stitch",
+              'prose=s', \$prose);
     badusage "no arguments allowed" if @ARGV;
     do_stitch $prose, 0;
 }
@@ -1566,8 +1604,8 @@ sub make_patches ($) {
 
 sub cmd_make_patches () {
     my $opt_quiet_would_amend;
-    GetOptions('quiet-would-amend!', \$opt_quiet_would_amend)
-       or badusage("bad options to make-patches");
+    getoptions("make-patches",
+              'quiet-would-amend!', \$opt_quiet_would_amend);
     badusage "no arguments allowed" if @ARGV;
     my $old_head = get_head();
     my $new = make_patches $old_head;
@@ -1589,19 +1627,30 @@ sub cmd_make_patches () {
 }
 
 sub cmd_convert_from_gbp () {
-    badusage "needs 1 optional argument, the upstream git rev"
+    badusage "want only 1 optional argument, the upstream git commitish"
        unless @ARGV<=1;
+
+    my $clogp = parsechangelog();
+    my $version = $clogp->{'Version'}
+       // die "missing Version from changelog";
+
     my ($upstream_spec) = @ARGV;
-    $upstream_spec //= 'refs/heads/upstream';
-    my $upstream = git_rev_parse $upstream_spec;
+
+    my ($upstream, $upstream_version) =
+       resolve_upstream_version($upstream_spec, $version);
+
     my $old_head = get_head();
 
     my $upsdiff = get_differs $upstream, $old_head;
     if ($upsdiff & D_UPS) {
-       runcmd @git, qw(--no-pager diff),
+       runcmd @git, qw(--no-pager diff --stat),
            $upstream, $old_head,
            qw( -- :!/debian :/);
- fail "upstream ($upstream_spec) and HEAD are not identical in upstream files";
+       fail <<END;
+upstream ($upstream_spec) and HEAD are not
+identical in upstream files.  See diffstat above, or run
+  git diff $upstream_spec HEAD -- :!/debian :/
+END
     }
 
     if (!is_fast_fwd $upstream, $old_head) {
@@ -1658,7 +1707,7 @@ sub cmd_convert_from_gbp () {
        print STDERR "cannot stitch in dgit view: $@\n";
     }
 
-    snags_maybe_bail();
+    snags_maybe_bail_early();
 
     my $work;
 
@@ -1696,6 +1745,8 @@ sub cmd_convert_from_gbp () {
        }
     };
 
+    ffq_check $work;
+    snags_maybe_bail();
     update_head_checkout $old_head, $work, 'convert-from-gbp';
 }
 
@@ -1774,7 +1825,9 @@ sub cmd_downstream_rebase_launder_v0 () {
     }
 }
 
-GetOptions("D+" => \$debuglevel,
+getoptions_main
+          ("bad options\n",
+          "D+" => \$debuglevel,
           'noop-ok', => \$opt_noop_ok,
           'f=s' => \@snag_force_opts,
           'anchor=s' => \@opt_anchors,
@@ -1790,7 +1843,10 @@ GetOptions("D+" => \$debuglevel,
               # approach.  '-i=s{0,}' does not work with bundling.
               push @$opt_defaultcmd_interactive, @ARGV;
               @ARGV=();
-          }) or badusage "bad options\n";
+          },
+          'help' => sub { print $usage_message or die $!; finish 0; },
+          );
+
 initdebug('git-debrebase ');
 enabledebug if $debuglevel;