]> git.madduck.net Git - code/myrepos.git/blobdiff - mr

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

add mr list command, and clarify what repos it will choose to act on
[code/myrepos.git] / mr
diff --git a/mr b/mr
index 72c917c66353024481761a1ca8dae5ed2668702f..823e3df3ea1f989c9930684e8a12528409af804a 100755 (executable)
--- a/mr
+++ b/mr
@@ -14,6 +14,8 @@ B<mr> [options] status
 
 B<mr> [options] commit [-m "message"]
 
+B<mr> [options] diff
+
 B<mr> [options] action [params ...]
 
 =head1 DESCRIPTION
@@ -30,35 +32,54 @@ control system:
 
 =over 4
 
-=item checkout
+=item checkout (or co)
 
-Checks out all the registered repositories that are not already checked
-out.
+Checks out any repositories that are not already checked out.
 
 =item update
 
-Updates each registered repository from its configured remote repository.
+Updates each repository from its configured remote repository.
 
 If a repository isn't checked out yet, it will first check it out.
 
 =item status
 
-Displays a status report for each registered repository, showing what
+Displays a status report for each repository, showing what
 uncommitted changes are present in the repository.
 
-=item commit
+=item commit (or ci)
 
-Commits changes to each registered repository. (By default, changes
-are pushed to the remote repository too, when using distributed systems
-like git.)
+Commits changes to each repository. (By default, changes are pushed to the
+remote repository too, when using distributed systems like git.)
 
 The optional -m parameter allows specifying a commit message.
 
+=item diff
+
+Show a diff of uncommitted changes.
+
+=item list
+
+List the repositories that mr will act on.
+
+=item help
+
+Displays this help.
+
 =back
 
 Actions can be abbreviated to any unambiguous subsctring, so
 "mr st" is equivilant to "mr status".
 
+B<mr> operates on all registered repsitories at or below your working
+directory. Or, if you are in a subdirectory of a repository, it will act on
+only that repository.
+
+Additional parameters can be passed to other commands than "commit", they
+will be passed on unchanged to the underlying revision control system.
+This is mostly useful if the repositories mr will act on all use the same
+revision control system.
+
 =head1 OPTIONS
 
 =over 4
@@ -82,9 +103,10 @@ Be verbose.
 
 =head1 FILES
 
-B<mr> is configured by .mrconfig files. It searches for .mrconfig files in
-your home directory, and in the root directory of each repository specified
-in a .mrconfig file. So you could have a ~/.mrconfig that registers a
+B<mr> is configured by .mrconfig files. It starts by reading the .mrconfig
+file in your home directory. Each repository specified in a .mrconfig file
+can also have its own .mrconfig file in its root directory that can
+optionally be used as well. So you could have a ~/.mrconfig that registers a
 repository ~/src, that itself contains a ~/src/.mrconfig file, that in turn
 registers several additional repositories.
 
@@ -100,24 +122,43 @@ environment, where any additional parameters you pass are available in
 a command, except for the "checkout" command, which is run in the parent
 of the repository directory, since the repository isn't checked out yet.
 
-There are two special parameters. If the "skip" parameter is set and
+There are three special parameters. If the "skip" parameter is set and
 its command returns nonzero, then B<mr> will skip acting on that repository.
+If the "chain" parameter is set and its command returns nonzero, then B<mr>
+will try to load a .mrconfig file from the root of the repository. (You
+should avoid chaining from repositories with untrusted committers.) The
+"lib" parameter can specify some shell code that will be run before each
+command, this can be a useful way to define shell functions other commands
+can use.
 
 The "default" section allows setting up default handlers for each action,
 and is overridden by the contents of other sections. mr contains default
 handlers for the "update", "status", and "commit" actions, so normally
 you only need to specify what to do for "checkout".
 
+The "alias" section allows adding aliases for commands. Each parameter
+is an alias, and its value is the command to run.
+
 For example:
 
   [src]
   checkout = svn co svn://svn.example.com/src/trunk src
+  chain = true
 
   [src/linux-2.6]
-  # only check this out on kodama
-  skip = test $(hostname) != kodama
+  skip = small
   checkout = git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
 
+  [default]
+  lib = \
+  small() {
+       case "$(hostname)" in; \
+       slug|snail); \
+               return 0; ;; ; \
+       esac; \
+       return 1; \
+  }
+
 =head1 AUTHOR
 
 Copyright 2007 Joey Hess <joey@kitenet.net>
@@ -138,6 +179,7 @@ my $config="$ENV{HOME}/.mrconfig";
 my $verbose=0;
 my %config;
 my %knownactions;
+my %alias;
 
 Getopt::Long::Configure("no_permute");
 my $result=GetOptions(
@@ -146,7 +188,9 @@ my $result=GetOptions(
        "v" => \$verbose,
 );
 if (! $result || @ARGV < 1) {
-       die("Usage: mr [-d directory] action [params ...]\n");
+       die("Usage: mr [-d directory] action [params ...]\n".
+           "(Use mr help for man page.)\n");
+
 }
 
 loadconfig(\*DATA);
@@ -154,19 +198,43 @@ loadconfig($config);
 #use Data::Dumper;
 #print Dumper(\%config);
 
+eval {
+       use FindBin qw($Bin $Script);
+       $ENV{MR_PATH}=$Bin."/".$Script;
+};
+
+# alias expansion and command stemming
 my $action=shift @ARGV;
-if (! $knownactions{$action}) {
-       my @matches = grep { /^\Q$action\E/ } keys %knownactions;
-       if (@matches == 1) {
-               $action=$matches[0];
+if (! exists $knownactions{$action}) {
+       if (exists $alias{$action}) {
+               $action=$alias{$action};
        }
        else {
-               die "mr: ambiguous action \"$action\" (matches @matches)\n";
+               my @matches = grep { /^\Q$action\E/ }
+                       keys %knownactions, keys %alias;
+               if (@matches == 1) {
+                       $action=$matches[0];
+               }
+               else {
+                       die "mr: ambiguous action \"$action\" (matches @matches)\n";
+               }
+       }
+}
+
+if ($action eq 'help') {
+       exec($config{''}{default}{help});
+}
+
+# handle being in a subdir of a repository
+foreach my $topdir (sort keys %config) {
+       foreach my $subdir (sort keys %{$config{$topdir}}) {
+               if ($directory =~ /^\Q$topdir$subdir\E\//) {
+                       $directory=$topdir.$subdir;
+               }
        }
 }
 
 my (@failed, @successful, @skipped);
-my $first=1;
 foreach my $topdir (sort keys %config) {
        foreach my $subdir (sort keys %{$config{$topdir}}) {
                next if $subdir eq 'default';
@@ -176,56 +244,55 @@ foreach my $topdir (sort keys %config) {
                if (defined $directory &&
                    $dir ne $directory &&
                    $dir !~ /^\Q$directory\E\//) {
-                       print "mr $action: $dir skipped per -d parameter ($directory)\n" if $verbose;
-                       push @skipped, $dir;
                        next;
                }
 
-               print "\n" unless $first;
-               $first=0;
-
-               if (exists $config{$topdir}{$subdir}{skip}) {
-                       my $ret=system($config{$topdir}{$subdir}{skip});
-                       if ($ret >> 8 == 0) {
-                               print "mr $action: $dir skipped per config file\n" if $verbose;
-                               push @skipped, $dir;
-                               next;
-                       }
-               }
-
                action($action, $dir, $topdir, $subdir);
-
        }
 }
 
 sub action {
        my ($action, $dir, $topdir, $subdir) = @_;
+       
+       my $lib= exists $config{$topdir}{$subdir}{lib} ?
+                       $config{$topdir}{$subdir}{lib} : "";
 
        if ($action eq 'checkout') {
                if (-d $dir) {
-                       print "mr $action: $dir already exists, skipping checkout\n";
+                       print "mr $action: $dir already exists, skipping checkout\n" if $verbose;
                        push @skipped, $dir;
-                       next;
+                       return;
                }
                $dir=~s/^(.*)\/[^\/]+\/?$/$1/;
        }
-       if ($action eq 'update') {
+       elsif ($action eq 'update') {
                if (! -d $dir) {
                        return action("checkout", $dir, $topdir, $subdir);
                }
        }
-
+       
        if (! chdir($dir)) {
                print STDERR "mr $action: failed to chdir to $dir: $!\n";
                push @skipped, $dir;
        }
-       elsif (! exists $config{$topdir}{$subdir}{$action}) {
+
+       if (exists $config{$topdir}{$subdir}{skip}) {
+               my $ret=system($lib.$config{$topdir}{$subdir}{skip});
+               if ($ret >> 8 == 0) {
+                       print "mr $action: $dir skipped per config file\n" if $verbose;
+                       push @skipped, $dir;
+                       return;
+               }
+       }
+
+       if (! exists $config{$topdir}{$subdir}{$action}) {
                print STDERR "mr $action: no defined $action command for $topdir$subdir, skipping\n";
                push @skipped, $dir;
        }
        else {
-               print "mr $action: in $dir\n";
-               my $command="set -e; my_action(){ $config{$topdir}{$subdir}{$action} ; }; my_action ".
+               print "mr $action: $dir\n";
+               my $command="set -e; ".$lib.
+                       "my_action(){ $config{$topdir}{$subdir}{$action} ; }; my_action ".
                        join(" ", map { s/\//\/\//g; s/"/\"/g; '"'.$_.'"' } @ARGV);
                my $ret=system($command);
                if ($ret != 0) {
@@ -241,6 +308,8 @@ sub action {
                else {
                        push @successful, $dir;
                }
+
+               print "\n";
        }
 }
 
@@ -253,12 +322,18 @@ sub showstat {
        }
        return;
 }
-print "\nmr $action: finished (".join("; ",
+print "mr $action: finished (".join("; ",
        showstat($#successful+1, "successful", "successful"),
        showstat($#failed+1, "failed", "failed"),
        showstat($#skipped+1, "skipped", "skipped"),
 ).")\n";
-exit @failed ? 1 : 0;
+if (@failed) {
+       exit 1;
+}
+elsif (! @successful && @skipped) {
+       exit 1;
+}
+exit 0;
 
 my %loaded;
 sub loadconfig {
@@ -305,10 +380,6 @@ sub loadconfig {
                next if /^\s*\#/ || /^\s*$/;
                if (/^\s*\[([^\]]*)\]\s*$/) {
                        $section=$1;
-                       if (length $dir && $section ne "default" &&
-                           -e $dir.$section."/.mrconfig") {
-                               push @toload, $dir.$section."/.mrconfig";
-                       }
                }
                elsif (/^\s*(\w+)\s*=\s*(.*)/) {
                        my $parameter=$1;
@@ -323,16 +394,31 @@ sub loadconfig {
                        if (! defined $section) {
                                die "$f line $.: parameter ($parameter) not in section\n";
                        }
-                       if (! exists $config{$dir}{$section} &&
-                             exists $config{$dir}{default}) {
+                       if ($section ne 'alias' &&
+                           ! exists $config{$dir}{$section} &&
+                           exists $config{$dir}{default}) {
                                # copy in defaults
                                $config{$dir}{$section}={ %{$config{$dir}{default}} };
                        }
-                       $config{$dir}{$section}{$parameter}=$value;
-                       $knownactions{$parameter}=1;
+                       if ($section eq 'alias') {
+                               $alias{$parameter}=$value;
+                       }
+                       elsif ($parameter eq 'lib') {
+                               $config{$dir}{$section}{lib}.=$value." ; ";
+                       }
+                       else {
+                               $config{$dir}{$section}{$parameter}=$value;
+                               $knownactions{$parameter}=1;
+                               if ($parameter eq 'chain' &&
+                                   length $dir && $section ne "default" &&
+                                   -e $dir.$section."/.mrconfig" &&
+                                   system($value) >> 8 == 0) {
+                                       push @toload, $dir.$section."/.mrconfig";
+                               }
+                       }
                }
                else {
-                               die "$f line $.: parse error\n";
+                       die "$f line $.: parse error\n";
                }
        }
        close $in;
@@ -342,34 +428,54 @@ sub loadconfig {
        }
 }
 
-__DATA__
-# Some useful actions that mr knows about by default.
+# Finally, some useful actions that mr knows about by default.
 # These can be overridden in ~/.mrconfig.
+__DATA__
+[alias]
+       co = checkout
+       ci = commit
 [default]
+lib = \
+       error() { \
+               echo "mr: $@" >&2; \
+               exit 1; \
+       }
 update = \
        if [ -d .svn ]; then \
-               svn update; \
+               svn update "$@"; \
        elif [ -d .git ]; then \
-               git pull origin master; \
+               git pull origin master "$@"; \
        else \
-               echo "mr update: unknown repo type"; \
-               exit 1; \
+               error "unknown repo type"; \
        fi
 status = \
        if [ -d .svn ]; then \
-               svn status; \
+               svn status "$@"; \
        elif [ -d .git ]; then \
-               git status || true; \
+               git status "$@" || true; \
        else \
-               echo "mr status: unknown repo type"; \
-               exit 1; \
+               error "unknown repo type"; \
        fi
 commit = \
        if [ -d .svn ]; then \
                svn commit "$@"; \
        elif [ -d .git ]; then \
-               git commit -a "$@" \
+               git commit -a "$@" && git push --all; \
        else \
-               echo "mr commit: unknown repo type"; \
-               exit 1; \
+               error "unknown repo type"; \
+       fi
+diff = \
+       if [ -d .svn ]; then \
+               svn diff "$@"; \
+       elif [ -d .git ]; then \
+               git diff "$@"; \
+       else \
+               error "unknown repo type"; \
        fi
+list = true
+help = \
+       if [ ! -e "$MR_PATH" ]; then \
+               error "cannot find program path";\
+       fi; \
+       (pod2man -c mr "$MR_PATH" | man -l -) || \
+               error "pod2man or man failed"