update docs

[code/myrepos.git] / mr

diff --git a/mr b/mr
index bb98ba674df60d6c2cc9e46537c87bc09190a12c..613f86a0d8853a518c3959de7725c40177b41497 100755 (executable)
--- a/mr
+++ b/mr
@@ -1,7 +1,5 @@
 #!/usr/bin/perl
 
 #!/usr/bin/perl
 

-#man{{{
-

 =head1 NAME
 
 mr - a Multiple Repository management tool
 =head1 NAME
 
 mr - a Multiple Repository management tool


@@ -28,6 +26,10 @@ B<mr> [options] config section ["parameter=[value]" ...]
 
 B<mr> [options] action [params ...]
 
 
 B<mr> [options] action [params ...]
 

+B<mr> [options] [online|offline]
+
+B<mr> [options] remember action [params ...]
+

 =head1 DESCRIPTION
 
 B<mr> is a Multiple Repository management tool. It can checkout, update, or
 =head1 DESCRIPTION
 
 B<mr> is a Multiple Repository management tool. It can checkout, update, or


@@ -77,6 +79,11 @@ remote repository. Only supported for distributed revision control systems.
 
 The optional -m parameter allows specifying a commit message.
 
 
 The optional -m parameter allows specifying a commit message.
 

+=item push
+
+Pushes committed local changes to the remote repository. A no-op for
+centralized revision control systems.
+

 =item diff
 
 Show a diff of uncommitted changes.
 =item diff
 
 Show a diff of uncommitted changes.


@@ -126,6 +133,24 @@ To see the built-in library of shell functions contained in mr:
 The ~/.mrconfig file is used by default. To use a different config file,
 use the -c option.
 
 The ~/.mrconfig file is used by default. To use a different config file,
 use the -c option.
 

+=item offline
+
+Advises mr that it is in offline mode. Any commands that fail in
+offline mode will be remembered, and retried when mr is told it's online.
+
+=item online
+
+Advices mr that it is in online mode again. Commands that failed while in
+offline mode will be re-run.
+
+=item remember
+
+Remember a command, to be run later when mr re-enters online mode. This
+implicitly puts mr into offline mode. The command can be any regular mr
+command. This is useful when you know that a command will fail due to being
+offline, and so don't want to run it right now at all, but just remember
+to run it when you go back online.
+

 =item help
 
 Displays this help.
 =item help
 
 Displays this help.


@@ -189,13 +214,18 @@ with no number specified. This can greatly speed up operations such as updates.
 It is not recommended for interactive operations.
 
 Note that running more than 10 jobs at a time is likely to run afoul of
 It is not recommended for interactive operations.
 
 Note that running more than 10 jobs at a time is likely to run afoul of

-ssh connection limits. Running between 3 and 5 jobs at a time will yeild
+ssh connection limits. Running between 3 and 5 jobs at a time will yield

 a good speedup in updates without loading the machine too much.
 
 =back
 
 =head1 FILES
 
 a good speedup in updates without loading the machine too much.
 
 =back
 
 =head1 FILES
 

+The ~/.mrlog file contains commands that mr has remembered to run later,
+due to being offline. You can delete or edit this file to remove commands,
+or even to add other commands for 'mr online' to run. If the file is
+present, mr assumes it is in offline mode.
+

 B<mr> is configured by .mrconfig files. It starts by reading the .mrconfig
 file in your home directory, and this can in turn chain load .mrconfig files
 from repositories.
 B<mr> is configured by .mrconfig files. It starts by reading the .mrconfig
 file in your home directory, and this can in turn chain load .mrconfig files
 from repositories.


@@ -311,6 +341,12 @@ the action that is performed for a given revision control system, you can
 override these rcs specific actions. To add a new revision control system,
 you can just add rcs specific actions for it.
 
 override these rcs specific actions. To add a new revision control system,
 you can just add rcs specific actions for it.
 

+=head1 EXTENSIONS
+
+mr can be extended to support things such as unison and git-svn. Some
+files providing such extensions are available in /usr/share/mr/. See
+the documentation in the files for details about using them.
+

 =head1 AUTHOR
 
 Copyright 2007 Joey Hess <joey@kitenet.net>
 =head1 AUTHOR
 
 Copyright 2007 Joey Hess <joey@kitenet.net>


@@ -321,8 +357,6 @@ http://kitenet.net/~joey/code/mr/
 
 =cut
 
 
 =cut
 

-#}}}
-

 use warnings;
 use strict;
 use Getopt::Long;
 use warnings;
 use strict;
 use Getopt::Long;


@@ -358,7 +392,7 @@ my (@ok, @failed, @skipped);
 main();
 
 my %rcs;
 main();
 
 my %rcs;

-sub rcs_test { #{{{
+sub rcs_test {

        my ($action, $dir, $topdir, $subdir) = @_;
 
        if (exists $rcs{$dir}) {
        my ($action, $dir, $topdir, $subdir) = @_;
 
        if (exists $rcs{$dir}) {


@@ -384,7 +418,7 @@ sub rcs_test { #{{{
        chomp $rcs;
        if ($rcs=~/\n/s) {
                $rcs=~s/\n/, /g;
        chomp $rcs;
        if ($rcs=~/\n/s) {
                $rcs=~s/\n/, /g;

-               print STDERR "mr $action: found multiple possible repository types ($rcs) for $topdir$subdir\n";
+               print STDERR "mr $action: found multiple possible repository types ($rcs) for $dir\n";

                return undef;
        }
        if (! length $rcs) {
                return undef;
        }
        if (! length $rcs) {


@@ -393,9 +427,9 @@ sub rcs_test { #{{{
        else {
                return $rcs{$dir}=$rcs;
        }
        else {
                return $rcs{$dir}=$rcs;
        }

-} #}}}
+}

        
        

-sub findcommand { #{{{
+sub findcommand {

        my ($action, $dir, $topdir, $subdir, $is_checkout) = @_;
        
        if (exists $config{$topdir}{$subdir}{$action}) {
        my ($action, $dir, $topdir, $subdir, $is_checkout) = @_;
        
        if (exists $config{$topdir}{$subdir}{$action}) {


@@ -415,16 +449,18 @@ sub findcommand { #{{{
        else {
                return undef;
        }
        else {
                return undef;
        }

-} #}}}
+}

 
 

-sub action { #{{{
+sub action {

        my ($action, $dir, $topdir, $subdir) = @_;
        my ($action, $dir, $topdir, $subdir) = @_;

-
+       

        $ENV{MR_CONFIG}=$configfiles{$topdir};
        my $lib=exists $config{$topdir}{$subdir}{lib} ?
                       $config{$topdir}{$subdir}{lib}."\n" : "";
        my $is_checkout=($action eq 'checkout');
 
        $ENV{MR_CONFIG}=$configfiles{$topdir};
        my $lib=exists $config{$topdir}{$subdir}{lib} ?
                       $config{$topdir}{$subdir}{lib}."\n" : "";
        my $is_checkout=($action eq 'checkout');
 

+       $ENV{MR_REPO}=$dir;
+

        if ($is_checkout) {
                if (-d $dir) {
                        print "mr $action: $dir already exists, skipping checkout\n" if $verbose;
        if ($is_checkout) {
                if (-d $dir) {
                        print "mr $action: $dir already exists, skipping checkout\n" if $verbose;


@@ -439,8 +475,6 @@ sub action { #{{{
                }
        }
 
                }
        }
 

-       $ENV{MR_REPO}=$dir;
-

        my $skiptest=findcommand("skip", $dir, $topdir, $subdir, $is_checkout);
        my $command=findcommand($action, $dir, $topdir, $subdir, $is_checkout);
 
        my $skiptest=findcommand("skip", $dir, $topdir, $subdir, $is_checkout);
        my $command=findcommand($action, $dir, $topdir, $subdir, $is_checkout);
 


@@ -477,22 +511,22 @@ sub action { #{{{
        elsif (! defined $command) {
                my $rcs=rcs_test(@_);
                if (! defined $rcs) {
        elsif (! defined $command) {
                my $rcs=rcs_test(@_);
                if (! defined $rcs) {

-                       print STDERR "mr $action: unknown repository type and no defined $action command for $topdir$subdir\n";
+                       print STDERR "mr $action: unknown repository type and no defined $action command for $dir\n";

                        return FAILED;
                }
                else {
                        return FAILED;
                }
                else {

-                       print STDERR "mr $action: no defined action for $rcs repository $topdir$subdir, skipping\n";
+                       print STDERR "mr $action: no defined action for $rcs repository $dir, skipping\n";

                        return SKIPPED;
                }
        }
        else {
                if (! $no_chdir) {
                        return SKIPPED;
                }
        }
        else {
                if (! $no_chdir) {

-                       print "mr $action: $topdir$subdir\n" unless $quiet;
+                       print "mr $action: $dir\n" unless $quiet;

                }
                else {
                        my $s=$directory;
                }
                else {
                        my $s=$directory;

-                       $s=~s/^\Q$topdir$subdir\E\/?//;
-                       print "mr $action: $topdir$subdir (in subdir $s)\n" unless $quiet;
+                       $s=~s/^\Q$dir\E\/?//;
+                       print "mr $action: $dir (in subdir $s)\n" unless $quiet;

                }
                $command="set -e; ".$lib.
                        "my_action(){ $command\n }; my_action ".
                }
                $command="set -e; ".$lib.
                        "my_action(){ $command\n }; my_action ".


@@ -511,6 +545,14 @@ sub action { #{{{
                        print STDERR "mr $action: failed ($ret)\n" if $verbose;
                        if ($ret >> 8 != 0) {
                                print STDERR "mr $action: command failed\n";
                        print STDERR "mr $action: failed ($ret)\n" if $verbose;
                        if ($ret >> 8 != 0) {
                                print STDERR "mr $action: command failed\n";

+                               if (-e "$ENV{HOME}/.mrlog" && $action ne 'remember') {
+                                       # recreate original command line to
+                                       # remember, and avoid recursing
+                                       my @orig=@ARGV;
+                                       @ARGV=('-n', $action, @orig);
+                                       action("remember", $dir, $topdir, $subdir);
+                                       @ARGV=@orig;
+                               }

                        }
                        elsif ($ret != 0) {
                                print STDERR "mr $action: command died ($ret)\n";
                        }
                        elsif ($ret != 0) {
                                print STDERR "mr $action: command died ($ret)\n";


@@ -526,10 +568,10 @@ sub action { #{{{
                        return OK;
                }
        }
                        return OK;
                }
        }

-} #}}}
+}

 
 # run actions on multiple repos, in parallel
 
 # run actions on multiple repos, in parallel

-sub mrs { #{{{
+sub mrs {

        my $action=shift;
        my @repos=@_;
 
        my $action=shift;
        my @repos=@_;
 


@@ -596,9 +638,9 @@ sub mrs { #{{{
                        }
                }
        }
                        }
                }
        }

-} #}}}
+}

 
 

-sub record { #{{{
+sub record {

        my $dir=shift()->[0];
        my $ret=shift;
 
        my $dir=shift()->[0];
        my $ret=shift;
 


@@ -624,9 +666,9 @@ sub record { #{{{
        else {
                die "unknown exit status $ret";
        }
        else {
                die "unknown exit status $ret";
        }

-} #}}}
+}

 
 

-sub showstats { #{{{
+sub showstats {

        my $action=shift;
        if (! @ok && ! @failed && ! @skipped) {
                die "mr $action: no repositories found to work on\n";
        my $action=shift;
        if (! @ok && ! @failed && ! @skipped) {
                die "mr $action: no repositories found to work on\n";


@@ -644,9 +686,9 @@ sub showstats { #{{{
                        print STDERR "mr $action: (failed: ".join(" ", @failed).")\n";
                }
        }
                        print STDERR "mr $action: (failed: ".join(" ", @failed).")\n";
                }
        }

-} #}}}
+}

 
 

-sub showstat { #{{{
+sub showstat {

        my $count=shift;
        my $singular=shift;
        my $plural=shift;
        my $count=shift;
        my $singular=shift;
        my $plural=shift;


@@ -654,10 +696,10 @@ sub showstat { #{{{
                return "$count ".($count > 1 ? $plural : $singular);
        }
        return;
                return "$count ".($count > 1 ? $plural : $singular);
        }
        return;

-} #}}}
+}

 
 # an ordered list of repos
 
 # an ordered list of repos

-sub repolist { #{{{
+sub repolist {

        my @list;
        foreach my $topdir (sort keys %config) {
                foreach my $subdir (sort keys %{$config{$topdir}}) {
        my @list;
        foreach my $topdir (sort keys %config) {
                foreach my $subdir (sort keys %{$config{$topdir}}) {


@@ -675,10 +717,10 @@ sub repolist { #{{{
                             ||
                $a->{subdir} cmp $b->{subdir}
        } @list;
                             ||
                $a->{subdir} cmp $b->{subdir}
        } @list;

-} #}}}
+}

 
 # figure out which repos to act on
 
 # figure out which repos to act on

-sub selectrepos { #{{{
+sub selectrepos {

        my @repos;
        foreach my $repo (repolist()) {
                my $topdir=$repo->{topdir};
        my @repos;
        foreach my $repo (repolist()) {
                my $topdir=$repo->{topdir};


@@ -717,9 +759,9 @@ sub selectrepos { #{{{
                $no_chdir=1;
        }
        return @repos;
                $no_chdir=1;
        }
        return @repos;

-} #}}}
+}

 
 

-sub expandenv { #{{{
+sub expandenv {

        my $val=shift;
        
 
        my $val=shift;
        
 


@@ -729,10 +771,10 @@ sub expandenv { #{{{
        }
        
        return $val;
        }
        
        return $val;

-} #}}}
+}

 
 my %loaded;
 
 my %loaded;

-sub loadconfig { #{{{
+sub loadconfig {

        my $f=shift;
 
        my @toload;
        my $f=shift;
 
        my @toload;


@@ -808,6 +850,9 @@ sub loadconfig { #{{{
                        if ($parameter eq "include") {
                                print "mr: including output of \"$value\"\n" if $verbose;
                                unshift @lines, `$value`;
                        if ($parameter eq "include") {
                                print "mr: including output of \"$value\"\n" if $verbose;
                                unshift @lines, `$value`;

+                               if ($?) {
+                                       print STDERR "mr: include command exited nonzero ($?)\n";
+                               }

                                next;
                        }
 
                                next;
                        }
 


@@ -861,9 +906,9 @@ sub loadconfig { #{{{
        foreach (@toload) {
                loadconfig($_);
        }
        foreach (@toload) {
                loadconfig($_);
        }

-} #}}}
+}

 
 

-sub modifyconfig { #{{{
+sub modifyconfig {

        my $f=shift;
        # the section to modify or add
        my $targetsection=shift;
        my $f=shift;
        # the section to modify or add
        my $targetsection=shift;


@@ -958,9 +1003,9 @@ sub modifyconfig { #{{{
        open(my $out, ">", $f) || die "mr: write $f: $!\n";
        print $out @out;
        close $out;     
        open(my $out, ">", $f) || die "mr: write $f: $!\n";
        print $out @out;
        close $out;     

-} #}}}
+}

 
 

-sub dispatch { #{{{
+sub dispatch {

        my $action=shift;
 
        # actions that do not operate on all repos
        my $action=shift;
 
        # actions that do not operate on all repos


@@ -973,6 +1018,13 @@ sub dispatch { #{{{
        elsif ($action eq 'register') {
                register(@ARGV);
        }
        elsif ($action eq 'register') {
                register(@ARGV);
        }

+       elsif ($action eq 'remember' ||
+              $action eq 'offline' ||
+              $action eq 'online') {
+               my @repos=selectrepos;
+               action($action, @{$repos[0]}) if @repos;
+               exit 0;
+       }

 
        if (!$jobs || $jobs > 1) {
                mrs($action, selectrepos());
 
        if (!$jobs || $jobs > 1) {
                mrs($action, selectrepos());


@@ -982,13 +1034,13 @@ sub dispatch { #{{{
                        record($repo, action($action, @$repo));
                }
        }
                        record($repo, action($action, @$repo));
                }
        }

-} #}}}
+}

 
 

-sub help { #{{{
+sub help {

        exec($config{''}{DEFAULT}{help}) || die "exec: $!";
        exec($config{''}{DEFAULT}{help}) || die "exec: $!";

-} #}}}
-       
-sub config { #{{{
+}
+
+sub config {

        if (@_ < 2) {
                die "mr config: not enough parameters\n";
        }
        if (@_ < 2) {
                die "mr config: not enough parameters\n";
        }


@@ -1024,10 +1076,15 @@ sub config { #{{{
        }
        modifyconfig($ENV{MR_CONFIG}, $section, %changefields) if %changefields;
        exit 0;
        }
        modifyconfig($ENV{MR_CONFIG}, $section, %changefields) if %changefields;
        exit 0;

-} #}}}
+}

 
 

-sub register { #{{{
-       if (! $config_overridden) {
+sub register {
+       if ($config_overridden) {
+               # Find the directory that the specified config file is
+               # located in.
+               ($directory)=abs_path($ENV{MR_CONFIG})=~/^(.*\/)[^\/]+$/;
+       }
+       else {

                # Find the closest known mrconfig file to the current
                # directory.
                $directory.="/" unless $directory=~/\/$/;
                # Find the closest known mrconfig file to the current
                # directory.
                $directory.="/" unless $directory=~/\/$/;


@@ -1064,10 +1121,10 @@ sub register { #{{{
                join(" ", map { s/\//\/\//g; s/"/\"/g; '"'.$_.'"' } @ARGV);
        print "mr register: running >>$command<<\n" if $verbose;
        exec($command) || die "exec: $!";
                join(" ", map { s/\//\/\//g; s/"/\"/g; '"'.$_.'"' } @ARGV);
        print "mr register: running >>$command<<\n" if $verbose;
        exec($command) || die "exec: $!";

-} #}}}
+}

 
 # alias expansion and command stemming
 
 # alias expansion and command stemming

-sub expandaction { #{{{
+sub expandaction {

        my $action=shift;
        if (exists $alias{$action}) {
                $action=$alias{$action};
        my $action=shift;
        if (exists $alias{$action}) {
                $action=$alias{$action};


@@ -1088,9 +1145,10 @@ sub expandaction { #{{{
                }
        }
        return $action;
                }
        }
        return $action;

-} #}}}
+}

 
 

-sub getopts { #{{{
+sub getopts {
+       my @saved=@ARGV;

        Getopt::Long::Configure("bundling", "no_permute");
        my $result=GetOptions(
                "d|directory=s" => sub { $directory=abs_path($_[1]) },
        Getopt::Long::Configure("bundling", "no_permute");
        my $result=GetOptions(
                "d|directory=s" => sub { $directory=abs_path($_[1]) },


@@ -1106,9 +1164,15 @@ sub getopts { #{{{
                die("Usage: mr [-d directory] action [params ...]\n".
                    "(Use mr help for man page.)\n");
        }
                die("Usage: mr [-d directory] action [params ...]\n".
                    "(Use mr help for man page.)\n");
        }

-} #}}}
+       
+       $ENV{MR_SWITCHES}="";
+       foreach my $option (@saved) {
+               last if $option eq $ARGV[0];
+               $ENV{MR_SWITCHES}.="$option ";
+       }
+}

 
 

-sub init { #{{{
+sub init {

        $SIG{INT}=sub {
                print STDERR "mr: interrupted\n";
                exit 2;
        $SIG{INT}=sub {
                print STDERR "mr: interrupted\n";
                exit 2;


@@ -1130,15 +1194,16 @@ sub init { #{{{
                use FindBin qw($Bin $Script);
                $ENV{MR_PATH}=$Bin."/".$Script;
        };
                use FindBin qw($Bin $Script);
                $ENV{MR_PATH}=$Bin."/".$Script;
        };

-} #}}}
+}

 
 

-sub main { #{{{
+sub main {

        getopts();
        init();
        getopts();
        init();

+

        loadconfig(\*DATA);
        loadconfig($ENV{MR_CONFIG});
        #use Data::Dumper; print Dumper(\%config);
        loadconfig(\*DATA);
        loadconfig($ENV{MR_CONFIG});
        #use Data::Dumper; print Dumper(\%config);

-
+       

        my $action=expandaction(shift @ARGV);
        dispatch($action);
        showstats($action);
        my $action=expandaction(shift @ARGV);
        dispatch($action);
        showstats($action);


@@ -1152,11 +1217,10 @@ sub main { #{{{
        else {
                exit 0;
        }
        else {
                exit 0;
        }

-} #}}}
+}

 
 # Finally, some useful actions that mr knows about by default.
 # These can be overridden in ~/.mrconfig.
 
 # Finally, some useful actions that mr knows about by default.
 # These can be overridden in ~/.mrconfig.

-#DATA{{{

 __DATA__
 [ALIAS]
 co = checkout
 __DATA__
 [ALIAS]
 co = checkout


@@ -1235,6 +1299,13 @@ bzr_record = bzr commit "$@"
 hg_record  = hg commit -m "$@"
 darcs_record = darcs record -a -m "$@"
 
 hg_record  = hg commit -m "$@"
 darcs_record = darcs record -a -m "$@"
 

+svn_push = :
+git_push = git push "$@"
+bzr_push = bzr push "$@"
+cvs_push = :
+hg_push = hg push "$@"
+darcs_push = darcs push -a "$@"
+

 svn_diff = svn diff "$@"
 git_diff = git diff "$@"
 bzr_diff = bzr diff "$@"
 svn_diff = svn diff "$@"
 git_diff = git diff "$@"
 bzr_diff = bzr diff "$@"


@@ -1306,9 +1377,33 @@ help =
 list = true
 config = 
 
 list = true
 config = 
 

+online =
+       if [ -s ~/.mrlog ]; then
+               info "running offline commands"
+               mv -f ~/.mrlog ~/.mrlog.old
+               if ! sh -e ~/.mrlog.old; then
+                       error "offline command failed; left in ~/.mrlog.old"
+               fi
+               rm -f ~/.mrlog.old
+       else
+               info "no offline commands to run"
+       fi
+offline =
+       umask 077
+       touch ~/.mrlog
+       info "offline mode enabled"
+remember =
+       info "remembering command: 'mr $@'"
+       command="mr -d '$(pwd)' $MR_SWITCHES"
+       for w in "$@"; do
+               command="$command '$w'"
+       done
+       if [ ! -e ~/.mrlog ] || ! grep -q -F "$command" ~/.mrlog; then
+               echo "$command" >> ~/.mrlog
+       fi
+

 ed = echo "A horse is a horse, of course, of course.."
 T = echo "I pity the fool."
 right = echo "Not found."
 ed = echo "A horse is a horse, of course, of course.."
 T = echo "I pity the fool."
 right = echo "Not found."

-#}}}

 
 # vim:sw=8:sts=0:ts=8:noet
 
 # vim:sw=8:sts=0:ts=8:noet