improve description

[code/myrepos.git] / mr

diff --git a/mr b/mr
index bed4cacf13dfd52ed95b3a0f4e031c42b108910f..3cc603f6c3fba08a3007afc2e8139c63238a74a3 100755 (executable)
--- a/mr
+++ b/mr
@@ -18,17 +18,19 @@ B<mr> [options] diff
 
 B<mr> [options] log
 
 
 B<mr> [options] log
 

+B<mr> [options] register [repository]
+
+B<mr> [options] config section [parameter=[value] ...]
+

 B<mr> [options] action [params ...]
 
 =head1 DESCRIPTION
 
 B<mr> [options] action [params ...]
 
 =head1 DESCRIPTION
 

-B<mr> is a Multiple Repository management tool. It allows you to register a
-set of repositories in a .mrconfig file, and then checkout, update, or
-perform other actions on the repositories as if they were one big
-respository.
-
-Any mix of revision control systems can be used with B<mr>, and you can
-define arbitrary actions for commands like "update", "checkout", or "commit".
+B<mr> is a Multiple Repository management tool. It
+can checkout, update, or perform other actions on
+a set of repositories as if they were one combined respository. It
+supports any combination of subversion, git, cvs, and bzr repositories, 
+and support for other revision control systems can easily be added.

 
 B<mr> cds into and operates on all registered repsitories at or below your
 working directory. Or, if you are in a subdirectory of a repository that
 
 B<mr> cds into and operates on all registered repsitories at or below your
 working directory. Or, if you are in a subdirectory of a repository that


@@ -74,6 +76,27 @@ Show the commit log.
 
 List the repositories that mr will act on.
 
 
 List the repositories that mr will act on.
 

+=item register
+
+Register an existing repository in the mrconfig file. By default, the
+epository in the current directory is registered, or you can specify a
+directory to register.
+
+=item config
+
+Adds, modifies, removes, or prints a value from the mrconfig file. The next
+parameter is the name of the section the value is in. To add or modify
+values, use one or more instances of "parameter=value". Use "parameter=" to
+remove a parameter. Use just "parameter" to get the value of a parameter.
+
+For example, to add (or edit) a repository in src/foo:
+
+  mr config src/foo checkout="svn co svn://example.com/foo/trunk foo"
+
+To show the command that mr uses to update the repository in src/foo:
+
+  mr config src/foo update
+

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


@@ -84,10 +107,10 @@ Actions can be abbreviated to any unambiguous subsctring, so
 "mr st" is equivilant to "mr status", and "mr up" is equivilant to "mr
 update"
 
 "mr st" is equivilant to "mr status", and "mr up" is equivilant to "mr
 update"
 

-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.
+Additional parameters can be passed to most commands, and are 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
 
 
 =head1 OPTIONS
 


@@ -122,10 +145,13 @@ Here is an example .mrconfig file:
   chain = true
 
   [src/linux-2.6]
   chain = true
 
   [src/linux-2.6]

-  checkout = git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
+  checkout = git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git &&
+       cd linux-2.6 &&
+       git checkout -b mybranch origin/master

 
 The .mrconfig file uses a variant of the INI file format. Lines starting with
 
 The .mrconfig file uses a variant of the INI file format. Lines starting with

-"#" are comments. Lines ending with "\" are continued on to the next line.
+"#" are comments. Values can be continued to the following line by
+indenting the line with whitespace.

 
 The "DEFAULT" section allows setting default values for the sections that
 come after it.
 
 The "DEFAULT" section allows setting default values for the sections that
 come after it.


@@ -158,7 +184,16 @@ A few parameters have special meanings:
 =item skip
 
 If the "skip" parameter is set and its command returns nonzero, then B<mr>
 =item skip
 
 If the "skip" parameter is set and its command returns nonzero, then B<mr>

-will skip acting on that repository.
+will skip acting on that repository. The command is passed the action
+name in $1.
+
+Here are two examples. The first skips the repo unless
+mr is run by joey. The second uses the hours_since function
+(included in mr's built-in library) to skip updating the repo unless it's
+been at least 12 hours since the last update.
+
+  skip = test $(whoami) != joey
+  skip = [ "$1" = update ] && [ $(hours_since "$1") -lt 12 ]

 
 =item chain
 
 
 =item chain
 


@@ -166,6 +201,14 @@ 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.)
 
 will try to load a .mrconfig file from the root of the repository. (You
 should avoid chaining from repositories with untrusted committers.)
 

+=item deleted
+
+If the "deleted" parameter is set and its command returns nonzero, then
+B<mr> will treat the repository as deleted. It won't ever actually delete
+the repository, but it will warn if it sees the repsoitory's directory.
+This is useful when one mrconfig file is shared amoung multiple machines,
+to keep track of and remember to delete old repositories.
+

 =item lib
 
 The "lib" parameter can specify some shell code that will be run before each
 =item lib
 
 The "lib" parameter can specify some shell code that will be run before each


@@ -240,7 +283,48 @@ if (! exists $knownactions{$action}) {
 }
 
 if ($action eq 'help') {
 }
 
 if ($action eq 'help') {

-       exec($config{''}{DEFAULT}{help});
+       exec($config{''}{DEFAULT}{$action}) || die "exec: $!";
+}
+elsif ($action eq 'config') {
+       if (@ARGV < 2) {
+               die "mr config: not enough parameters\n";
+       }
+       my $section=shift;
+       if ($section=~/^\//) {
+               # try to convert to a path relative to $config's dir
+               my ($dir)=$config=~/^(.*\/)[^\/]+$/;
+               if ($section=~/^\Q$dir\E(.*)/) {
+                       $section=$1;
+               }
+       }
+       my %changefields;
+       foreach (@ARGV) {
+               if (/^([^=]+)=(.*)$/) {
+                       $changefields{$1}=$2;
+               }
+               else {
+                       my $found=0;
+                       foreach my $topdir (sort keys %config) {
+                               if (exists $config{$topdir}{$section} &&
+                                   exists $config{$topdir}{$section}{$_}) {
+                                       print $config{$topdir}{$section}{$_}."\n";
+                                       $found=1;
+                               }
+                       }
+                       if (! $found) {
+                               die "mr $action: $section $_ not set\n";
+                       }
+               }
+       }
+       modifyconfig($config, $section, %changefields) if %changefields;
+       exit 0;
+}
+elsif ($action eq 'register') {
+       my $command="set -e; ".$config{''}{DEFAULT}{lib}."\n".
+               "my_action(){ $config{''}{DEFAULT}{$action}\n }; my_action ".
+               join(" ", map { s/\//\/\//g; s/"/\"/g; '"'.$_.'"' } @ARGV);
+       print STDERR "mr $action: running >>$command<<\n" if $verbose;
+       exec($command) || die "exec: $!";

 }
 
 # work out what repos to act on
 }
 
 # work out what repos to act on


@@ -286,6 +370,22 @@ sub action {
        my $lib= exists $config{$topdir}{$subdir}{lib} ?
                        $config{$topdir}{$subdir}{lib}."\n" : "";
 
        my $lib= exists $config{$topdir}{$subdir}{lib} ?
                        $config{$topdir}{$subdir}{lib}."\n" : "";
 

+       if (exists $config{$topdir}{$subdir}{deleted}) {
+               if (! -d $dir) {
+                       return;
+               }
+               else {
+                       my $test="set -e;".$lib.$config{$topdir}{$subdir}{deleted};
+                       print "mr $action: running deleted test >>$test<<\n" if $verbose;
+                       my $ret=system($test);
+                       if ($ret >> 8 == 0) {
+                               print STDERR "mr error: $dir should be deleted yet still exists\n\n";
+                               push @failed, $dir;
+                               return;
+                       }
+               }
+       }
+

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


@@ -303,7 +403,8 @@ sub action {
        $ENV{MR_REPO}=$dir;
 
        if (exists $config{$topdir}{$subdir}{skip}) {
        $ENV{MR_REPO}=$dir;
 
        if (exists $config{$topdir}{$subdir}{skip}) {

-               my $test="set -e;".$lib.$config{$topdir}{$subdir}{skip};
+               my $test="set -e;".$lib.
+                       "my_action(){ $config{$topdir}{$subdir}{skip}\n }; my_action '$action'";

                print "mr $action: running skip test >>$test<<\n" if $verbose;
                my $ret=system($test);
                if ($ret >> 8 == 0) {
                print "mr $action: running skip test >>$test<<\n" if $verbose;
                my $ret=system($test);
                if ($ret >> 8 == 0) {


@@ -385,19 +486,20 @@ sub loadconfig {
        my $in;
        my $dir;
        if (ref $f eq 'GLOB') {
        my $in;
        my $dir;
        if (ref $f eq 'GLOB') {

-               $in=$f; 

                $dir="";
                $dir="";

+               $in=$f; 

        }
        else {
        }
        else {

-               # $f might be a symlink
+               if (! -e $f) {
+                       return;
+               }
+

                my $absf=abs_path($f);
                if ($loaded{$absf}) {
                        return;
                }
                $loaded{$absf}=1;
 
                my $absf=abs_path($f);
                if ($loaded{$absf}) {
                        return;
                }
                $loaded{$absf}=1;
 

-               print "mr: loading config $f\n" if $verbose;
-               open($in, "<", $f) || die "mr: open $f: $!\n";

                ($dir)=$f=~/^(.*\/)[^\/]+$/;
                if (! defined $dir) {
                        $dir=".";
                ($dir)=$f=~/^(.*\/)[^\/]+$/;
                if (! defined $dir) {
                        $dir=".";


@@ -413,22 +515,29 @@ sub loadconfig {
                                last;
                        }
                }
                                last;
                        }
                }

+               
+               print "mr: loading config $f\n" if $verbose;
+               open($in, "<", $f) || die "mr: open $f: $!\n";

        }
        }

+       my @lines=<$in>;
+       close $in;

 
        my $section;
 
        my $section;

-       while (<$in>) {
+       while (@lines) {
+               $_=shift @lines;

                chomp;
                next if /^\s*\#/ || /^\s*$/;
                chomp;
                next if /^\s*\#/ || /^\s*$/;

-               if (/^\s*\[([^\]]*)\]\s*$/) {
+               if (/^\[([^\]]*)\]\s*$/) {

                        $section=$1;
                }
                        $section=$1;
                }

-               elsif (/^\s*(\w+)\s*=\s*(.*)/) {
+               elsif (/^(\w+)\s*=\s*(.*)/) {

                        my $parameter=$1;
                        my $value=$2;
 
                        my $parameter=$1;
                        my $value=$2;
 

-                       # continuation line
-                       while ($value=~/(.*)\\$/s) {
-                               $value=$1."\n".<$in>;
+                       # continued value
+                       while (@lines && $lines[0]=~/^\s(.+)/) {
+                               shift(@lines);
+                               $value.="\n$1";

                                chomp $value;
                        }
 
                                chomp $value;
                        }
 


@@ -462,96 +571,233 @@ sub loadconfig {
                        die "$f line $.: parse error\n";
                }
        }
                        die "$f line $.: parse error\n";
                }
        }

-       close $in;

 
        foreach (@toload) {
                loadconfig($_);
        }
 }
 
 
        foreach (@toload) {
                loadconfig($_);
        }
 }
 

+sub modifyconfig {
+       my $f=shift;
+       # the section to modify or add
+       my $targetsection=shift;
+       # fields to change in the section
+       # To remove a field, set its value to "".
+       my %changefields=@_;
+
+       my @lines;
+       my @out;
+
+       if (-e $f) {
+               open(my $in, "<", $f) || die "mr: open $f: $!\n";
+               @lines=<$in>;
+               close $in;
+       }
+
+       my $formatfield=sub {
+               my $field=shift;
+               my @value=split(/\n/, shift);
+
+               return "$field = ".shift(@value)."\n".
+                       join("", map { "\t$_\n" } @value);
+       };
+       my $addfields=sub {
+               my @blanks;
+               while ($out[$#out] =~ /^\s*$/) {
+                       unshift @blanks, pop @out;
+               }
+               foreach my $field (sort keys %changefields) {
+                       if (length $changefields{$field}) {
+                               push @out, "$field = $changefields{$field}\n";
+                               delete $changefields{$field};
+                       }
+               }
+               push @out, @blanks;
+       };
+
+       my $section;
+       while (@lines) {
+               $_=shift(@lines);
+
+               if (/^\s*\#/ || /^\s*$/) {
+                       push @out, $_;
+               }
+               elsif (/^\[([^\]]*)\]\s*$/) {
+                       if (defined $section && 
+                           $section eq $targetsection) {
+                               $addfields->();
+                       }
+
+                       $section=$1;
+
+                       push @out, $_;
+               }
+               elsif (/^(\w+)\s*=\s(.*)/) {
+                       my $parameter=$1;
+                       my $value=$2;
+
+                       # continued value
+                       while (@lines && $lines[0]=~/^\s(.+)/) {
+                               shift(@lines);
+                               $value.="\n$1";
+                               chomp $value;
+                       }
+
+                       if ($section eq $targetsection) {
+                               if (exists $changefields{$parameter}) {
+                                       if (length $changefields{$parameter}) {
+                                               $value=$changefields{$parameter};
+                                       }
+                                       delete $changefields{$parameter};
+                               }
+                       }
+
+                       push @out, $formatfield->($parameter, $value);
+               }
+       }
+
+       if (defined $section && 
+           $section eq $targetsection) {
+               $addfields->();
+       }
+       elsif (%changefields) {
+               push @out, "\n[$targetsection]\n";
+               foreach my $field (sort keys %changefields) {
+                       if (length $changefields{$field}) {
+                               push @out, $formatfield->($field, $changefields{$field});
+                       }
+               }
+       }
+
+       open(my $out, ">", $f) || die "mr: write $f: $!\n";
+       print $out @out;
+       close $out;     
+}
+

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

-       co = checkout
-       ci = commit
-       ls = list
+co = checkout
+ci = commit
+ls = list

 
 [DEFAULT]
 
 [DEFAULT]

-lib =                                                  \
-       error() {                                       \
-               echo "mr: $@" >&2                       \
-               exit 1                                  \
+lib =
+       error() {
+               echo "mr: $@" >&2
+               exit 1
+       }
+       hours_since() {
+               for dir in .git .svn .bzr CVS; do
+                       if [ -e "$MR_REPO/$dir" ]; then
+                               flagfile="$MR_REPO/$dir/.mr_last$1"
+                               break
+                       fi
+               done
+               if [ -z "$flagfile" ]; then
+                       error "cannot determine flag filename"
+               fi
+               perl -wle 'print -f shift() ? int((-M _) * 24) : 9999' "$flagfile"
+               touch "$flagfile"

        }
 
        }
 

-update =                                               \
-       if [ -d "$MR_REPO"/.svn ]; then                 \
-               svn update "$@"                         \
-       elif [ -d "$MR_REPO"/.git ]; then               \
-               git pull origin master "$@"             \
-       elif [ -d "$MR_REPO"/.bzr ]; then               \
-               bzr merge "$@"                          \
-       elif [ -d "$MR_REPO"/CVS ]; then                \
-               cvs update "$@"                         \
-       else                                            \
-               error "unknown repo type"               \
+update =
+       if [ -d "$MR_REPO"/.svn ]; then
+               svn update "$@"
+       elif [ -d "$MR_REPO"/.git ]; then
+               git pull origin master "$@"
+       elif [ -d "$MR_REPO"/.bzr ]; then
+               bzr merge "$@"
+       elif [ -d "$MR_REPO"/CVS ]; then
+               cvs update "$@"
+       else
+               error "unknown repo type"
+       fi
+status =
+       if [ -d "$MR_REPO"/.svn ]; then
+               svn status "$@"
+       elif [ -d "$MR_REPO"/.git ]; then
+               git status "$@" || true
+       elif [ -d "$MR_REPO"/.bzr ]; then
+               bzr status "$@"
+       elif [ -d "$MR_REPO"/CVS ]; then
+               cvs status "$@"
+       else
+               error "unknown repo type"
+       fi
+commit =
+       if [ -d "$MR_REPO"/.svn ]; then
+               svn commit "$@"
+       elif [ -d "$MR_REPO"/.git ]; then
+               git commit -a "$@" && git push --all
+       elif [ -d "$MR_REPO"/.bzr ]; then
+               bzr commit "$@" && bzr push
+       elif [ -d "$MR_REPO"/CVS ]; then
+               cvs commit "$@"
+       else
+               error "unknown repo type"

        fi
        fi

-status =                                               \
-       if [ -d "$MR_REPO"/.svn ]; then                 \
-               svn status "$@"                         \
-       elif [ -d "$MR_REPO"/.git ]; then               \
-               git status "$@" || true                 \
-       elif [ -d "$MR_REPO"/.bzr ]; then               \
-               bzr status "$@"                         \
-       elif [ -d "$MR_REPO"/CVS ]; then                \
-               cvs status "$@"                         \
-       else                                            \
-               error "unknown repo type"               \
+diff =
+       if [ -d "$MR_REPO"/.svn ]; then
+               svn diff "$@"
+       elif [ -d "$MR_REPO"/.git ]; then
+               git diff "$@"
+       elif [ -d "$MR_REPO"/.bzr ]; then
+               bzr diff "$@"
+       elif [ -d "$MR_REPO"/CVS ]; then
+               cvs diff "$@"
+       else
+               error "unknown repo type"

        fi
        fi

-commit =                                               \
-       if [ -d "$MR_REPO"/.svn ]; then                 \
-               svn commit "$@"                         \
-       elif [ -d "$MR_REPO"/.git ]; then               \
-               git commit -a "$@" && git push --all    \
-       elif [ -d "$MR_REPO"/.bzr ]; then               \
-               bzr commit "$@" && bzr push             \
-       elif [ -d "$MR_REPO"/CVS ]; then                \
-               cvs commit "$@"                         \
-       else                                            \
-               error "unknown repo type"               \
+log =
+       if [ -d "$MR_REPO"/.svn ]; then
+               svn log"$@"
+       elif [ -d "$MR_REPO"/.git ]; then
+               git log "$@"
+       elif [ -d "$MR_REPO"/.bzr ]; then
+               bzr log "$@"
+       elif [ -d "$MR_REPO"/CVS ]; then
+               cvs log "$@"
+       else
+               error "unknown repo type"

        fi
        fi

-diff =                                                 \
-       if [ -d "$MR_REPO"/.svn ]; then                 \
-               svn diff "$@"                           \
-       elif [ -d "$MR_REPO"/.git ]; then               \
-               git diff "$@"                           \
-       elif [ -d "$MR_REPO"/.bzr ]; then               \
-               bzr diff "$@"                           \
-       elif [ -d "$MR_REPO"/CVS ]; then                \
-               cvs diff "$@"                           \
-       else                                            \
-               error "unknown repo type"               \
+register =
+       if [ -n "$1" ]; then
+               cd "$1"

        fi
        fi

-log =                                                  \
-       if [ -d "$MR_REPO"/.svn ]; then                 \
-               svn log"$@"                             \
-       elif [ -d "$MR_REPO"/.git ]; then               \
-               git log "$@"                            \
-       elif [ -d "$MR_REPO"/.bzr ]; then               \
-               bzr log "$@"                            \
-       elif [ -d "$MR_REPO"/CVS ]; then                \
-               cvs log "$@"                            \
-       else                                            \
-               error "unknown repo type"               \
+       basedir="$(basename $(pwd))"
+       if [ -d .svn ]; then
+               url=$(LANG=C svn info . | grep -i ^URL: | cut -d ' ' -f 2)
+               if [ -z "$url" ]; then
+                       error "cannot determine svn url"
+               fi
+               echo "Registering svn url: $url"
+               mr config "$(pwd)" checkout="svn co $url $basedir"
+       elif [ -d .git ]; then
+               url=$(LANG=C git-config --get remote.origin.url)
+               if [ -z "$url" ]; then
+                       error "cannot determine git url"
+               fi
+               echo "Registering git url: $url"
+               mr config "$(pwd)" checkout="git clone $url $basedir"
+       elif [ -d .bzr ]; then
+               url=$(cat .bzr/branch/parent)
+               if [ -z "$url" ]; then
+                       error "cannot determine bzr url"
+               fi
+               echo "Registering bzr url: $url"
+               mr config "$(pwd)" checkout="bzr clone $url $basedir"
+       else
+               error "unable to register this repo type"

        fi
        fi

+help =
+       if [ ! -e "$MR_PATH" ]; then
+               error "cannot find program path"
+       fi
+       (pod2man -c mr "$MR_PATH" | man -l -) || error "pod2man or man failed"

 list = true
 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"
+config = 

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