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
repository. It supports any combination of subversion, git, cvs, mercurial,
-bzr, darcs and fossil repositories, and support for other revision
+bzr, darcs and fossil repositories, and support for other version
control systems can easily be added.
B<mr> cds into and operates on all registered repositories at or below your
looks for a .mrconfig file in the current directory, or in one of its
parent directories.
-These predefined commands should be fairly familiar to users of any revision
+These predefined commands should be fairly familiar to users of any version
control system:
=over 4
=item record
Records changes to the local repository, but does not push them to the
-remote repository. Only supported for distributed revision control systems.
+remote repository. Only supported for distributed version control systems.
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.
+centralized version control systems.
=item diff
update"
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
+unchanged to the underlying version control system. This is mostly useful
+if the repositories mr will act on all use the same version control
system.
=head1 OPTIONS
=item --config mrconfig
-Use the specified mrconfig file. The default is to use both B<~/.mrconfig>
-as well as look for a .mrconfig file in the current directory, or in one
+Use the specified mrconfig file. The default is to use both F<~/.mrconfig>
+as well as look for a F<.mrconfig> file in the current directory, or in one
of its parent directories.
=item -v
=item --quiet
-Be quiet. This supresses mr's usual output, as well as any output from
+Be quiet. This suppresses mr's usual output, as well as any output from
commands that are run (including stderr output). If a command fails,
the output will be shown.
=item --trust-all
-Trust all mrconfig files even if they are not listed in ~/.mrtrust.
+Trust all mrconfig files even if they are not listed in F<~/.mrtrust>.
Use with caution.
=item -p
=head1 MRCONFIG FILES
-Here is an example .mrconfig file:
+Here is an example F<.mrconfig> file:
[src]
checkout = svn checkout svn://svn.example.com/src/trunk src
cd linux-2.6 &&
git checkout -b mybranch origin/master
-The .mrconfig file uses a variant of the INI file format. Lines starting with
-"#" are comments. Values can be continued to the following line by
-indenting the line with whitespace.
+The F<.mrconfig> file uses a variant of the INI file format. Lines
+starting with "#" 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
+The C<DEFAULT> section allows setting default values for the sections that
come after it.
-The "ALIAS" section allows adding aliases for actions. Each parameter
+The C<ALIAS> section allows adding aliases for actions. Each parameter
is an alias, and its value is the action to use.
All other sections add repositories. The section header specifies the
that contains the mrconfig file, but you can also choose to use absolute
paths. (Note that you can use environment variables in section names; they
will be passed through the shell for expansion. For example,
-"[$HOSTNAME]", or "[${HOSTNAME}foo]")
+C<[$HOSTNAME]>, or C<[${HOSTNAME}foo]>).
Within a section, each parameter defines a shell command to run to handle a
given action. mr contains default handlers for "update", "status",
Normally you only need to specify what to do for "checkout". Here you
specify the command to run in order to create a checkout of the repository.
The command will be run in the parent directory, and must create the
-repository's directory. So use "git clone", "svn checkout", "bzr branch"
-or "bzr checkout" (for a bound branch), etc.
+repository's directory. So use C<git clone>, C<svn checkout>, C<bzr branch>
+or C<bzr checkout> (for a bound branch), etc.
-Note that these shell commands are run in a "set -e" shell
+Note that these shell commands are run in a C<set -e> shell
environment, where any additional parameters you pass are available in
-"$@". All commands other than "checkout" are run inside the repository,
+C<$@>. All commands other than "checkout" are run inside the repository,
though not necessarily at the top of it.
-The "MR_REPO" environment variable is set to the path to the top of the
+The C<MR_REPO> environment variable is set to the path to the top of the
repository. (For the "register" action, "MR_REPO" is instead set to the
basename of the directory that should be created when checking the
repository out.)
-The "MR_CONFIG" environment variable is set to the .mrconfig file
+The C<MR_CONFIG> environment variable is set to the .mrconfig file
that defines the repo being acted on, or, if the repo is not yet in a config
-file, the .mrconfig file that should be modified to register the repo.
+file, the F<.mrconfig> file that should be modified to register the repo.
-The "MR_ACTION" environment variable is set to the command being run
+The C<MR_ACTION> environment variable is set to the command being run
(update, checkout, etc).
A few parameters have special meanings:
If the "skip" parameter is set and its command returns true, then B<mr>
will skip acting on that repository. The command is passed the action
-name in $1.
+name in C<$1>.
Here are two examples. The first skips the repo unless
mr is run by joey. The second uses the hours_since function
=item chain
If the "chain" parameter is set and its command returns true, then B<mr>
-will try to load a .mrconfig file from the root of the repository.
+will try to load a F<.mrconfig> file from the root of the repository.
=item include
Unlike all other parameters, this parameter does not need to be placed
within a section.
+B<mr> ships several libraries that can be included to add support for
+additional version control type things (unison, git-svn, vcsh, git-fake-bare,
+git-subtree). To include them all, you could use:
+
+ include = cat /usr/share/mr/*
+
+See the individual files for details.
+
=item deleted
If the "deleted" parameter is set and its command returns true, 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 repository's directory.
-This is useful when one mrconfig file is shared amoung multiple machines,
+This is useful when one mrconfig file is shared among 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
-command, this can be a useful way to define shell functions for other commands
-to use.
+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 for other commands to use.
+
+Unlike most other parameters, this can be specified multiple times, in
+which case the chunks of shell code are accumulatively concatenated
+together.
=item fixups
like permissions fixups, or other tweaks to the repository content,
whenever the repository is changed.
+=item VCS_action
+
+When looking for a command to run for a given action, mr first looks for
+a parameter with the same name as the action. If that is not found, it
+looks for a parameter named "VCS_action" (substituting in the name of the
+version control system and the action). The name of the version control
+system is itself determined by running each defined "VCS_test" action,
+until one succeeds.
+
+Internally, mr has settings for "git_update", "svn_update", etc. To change
+the action that is performed for a given version control system, you can
+override these VCS specific actions. To add a new version control system,
+you can just add VCS specific actions for it.
+
=item pre_ and post_
If a "pre_action" parameter is set, its command is run before mr performs the
successfully performs the specified action. For example, "pre_commit" is
run before committing; "post_update" is run after updating.
-=back
+=item _append
-When looking for a command to run for a given action, mr first looks for
-a parameter with the same name as the action. If that is not found, it
-looks for a parameter named "rcs_action" (substituting in the name of the
-revision control system and the action). The name of the revision control
-system is itself determined by running each defined "rcs_test" action,
-until one succeeds.
+Any parameter can be suffixed with C<_append>, to add an additional value
+to the existing value of the parameter. In this way, actions
+can be constructed accumulatively.
-Internally, mr has settings for "git_update", "svn_update", etc. To change
-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.
+=back
=head1 UNTRUSTED MRCONFIG FILES
Since mrconfig files can contain arbitrary shell commands, they can do
anything. This flexibility is good, but it also allows a malicious mrconfig
file to delete your whole home directory. Such a file might be contained
-inside a repository that your main ~/.mrconfig checks out. To
+inside a repository that your main F<~/.mrconfig> checks out. To
avoid worries about evil commands in a mrconfig file, mr defaults to
-reading all mrconfig files other than the main ~/.mrconfig in untrusted
+reading all mrconfig files other than the main F<~/.mrconfig> in untrusted
mode. In untrusted mode, mrconfig files are limited to running only known
safe commands (like "git clone") in a carefully checked manner.
-To configure mr to trust other mrconfig files, list them in ~/.mrtrust.
+To configure mr to trust other mrconfig files, list them in F<~/.mrtrust>.
One mrconfig file should be listed per line. Either the full pathname
-should be listed, or the pathname can start with "~/" to specify a file
+should be listed, or the pathname can start with F<~/> to specify a file
relative to your home directory.
=head1 OFFLINE LOG FILE
-The ~/.mrlog file contains commands that mr has remembered to run later,
+The F<~/.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.
=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
+files providing such extensions are available in F</usr/share/mr/>. See
the documentation in the files for details about using them.
=head1 EXIT STATUS
main();
-my %rcs;
-sub rcs_test {
+my %vcs;
+sub vcs_test {
my ($action, $dir, $topdir, $subdir) = @_;
- if (exists $rcs{$dir}) {
- return $rcs{$dir};
+ if (exists $vcs{$dir}) {
+ return $vcs{$dir};
}
my $test="set -e\n";
- foreach my $rcs_test (
+ foreach my $vcs_test (
sort {
length $a <=> length $b
||
$a cmp $b
} grep { /_test$/ } keys %{$config{$topdir}{$subdir}}) {
- my ($rcs)=$rcs_test=~/(.*)_test/;
- $test="my_$rcs_test() {\n$config{$topdir}{$subdir}{$rcs_test}\n}\n".$test;
- $test.="if my_$rcs_test; then echo $rcs; fi\n";
+ my ($vcs)=$vcs_test=~/(.*)_test/;
+ $test="my_$vcs_test() {\n$config{$topdir}{$subdir}{$vcs_test}\n}\n".$test;
+ $test.="if my_$vcs_test; then echo $vcs; fi\n";
}
$test=$config{$topdir}{$subdir}{lib}."\n".$test
if exists $config{$topdir}{$subdir}{lib};
- print "mr $action: running rcs test >>$test<<\n" if $verbose;
- my $rcs=`$test`;
- chomp $rcs;
- if ($rcs=~/\n/s) {
- $rcs=~s/\n/, /g;
- print STDERR "mr $action: found multiple possible repository types ($rcs) for ".fulldir($topdir, $subdir)."\n";
+ print "mr $action: running vcs test >>$test<<\n" if $verbose;
+ my $vcs=`$test`;
+ chomp $vcs;
+ if ($vcs=~/\n/s) {
+ $vcs=~s/\n/, /g;
+ print STDERR "mr $action: found multiple possible repository types ($vcs) for ".fulldir($topdir, $subdir)."\n";
return undef;
}
- if (! length $rcs) {
- return $rcs{$dir}=undef;
+ if (! length $vcs) {
+ return $vcs{$dir}=undef;
}
else {
- return $rcs{$dir}=$rcs;
+ return $vcs{$dir}=$vcs;
}
}
return undef;
}
- my $rcs=rcs_test(@_);
+ my $vcs=vcs_test(@_);
- if (defined $rcs &&
- exists $config{$topdir}{$subdir}{$rcs."_".$action}) {
- return $config{$topdir}{$subdir}{$rcs."_".$action};
+ if (defined $vcs &&
+ exists $config{$topdir}{$subdir}{$vcs."_".$action}) {
+ return $config{$topdir}{$subdir}{$vcs."_".$action};
}
else {
return undef;
my $is_checkout=($action eq 'checkout');
my $is_update=($action =~ /update/);
- $ENV{MR_REPO}=$dir;
+ ($ENV{MR_REPO}=$dir) =~ s!/$!!;
$ENV{MR_ACTION}=$action;
foreach my $testname ("skip", "deleted") {
return FAILED;
}
elsif (! defined $command) {
- my $rcs=rcs_test(@_);
- if (! defined $rcs) {
+ my $vcs=vcs_test(@_);
+ if (! defined $vcs) {
print STDERR "mr $action: unknown repository type and no defined $action command for $fulldir\n";
return FAILED;
}
else {
- print STDERR "mr $action: no defined action for $rcs repository $fulldir, skipping\n";
+ print STDERR "mr $action: no defined action for $vcs repository $fulldir, skipping\n";
return SKIPPED;
}
}
return $ret;
}
-# figure out which repos to act on
+# Figure out which repos to act on. Returns a list of array refs
+# in the format:
+#
+# [ "$full_repo_path/", "$mr_config_path/", $section_header ]
sub selectrepos {
my @repos;
foreach my $repo (repolist()) {
return 0;
}
-sub trusterror {
- my ($err, $file, $line, $url)=@_;
-
- if (defined $url) {
- die "$err in untrusted $url line $line\n".
- "(To trust this url, --trust-all can be used; but please use caution;\n".
- "this can allow arbitrary code execution!)\n";
- }
- else {
- die "$err in untrusted $file line $line\n".
- "(To trust this file, list it in ~/.mrtrust.)\n";
- }
-}
-
my %loaded;
sub loadconfig {
my $f=shift;
close $in unless ref $f eq 'GLOB';
my $section;
- my $line=0;
+
+ # Keep track of the current line in the config file;
+ # when a file is included track the current line from the include.
+ my $lineno=0;
+ my $included=undef;
+
+ my $line;
+ my $nextline = sub {
+ if ($included) {
+ $included--;
+ }
+ else {
+ $included=undef;
+ $lineno++;
+ }
+ $line=shift @lines;
+ chomp $line;
+ return $line;
+ };
+ my $lineerror = sub {
+ my $msg=shift;
+ if (defined $included) {
+ die "mr: $msg at $f line $lineno, included line: $line\n";
+ }
+ else {
+ die "mr: $msg at $f line $lineno\n";
+ }
+ };
+ my $trusterror = sub {
+ my $msg=shift;
+ my ($err, $file, $lineno, $url)=@_;
+
+ if (defined $bootstrap_url) {
+ die "mr: $err in untrusted $bootstrap_url line $lineno\n".
+ "(To trust this url, --trust-all can be used; but please use caution;\n".
+ "this can allow arbitrary code execution!)\n";
+ }
+ else {
+ die "mr: $err in untrusted $file line $lineno\n".
+ "(To trust this file, list it in ~/.mrtrust.)\n";
+ }
+ };
+
while (@lines) {
- $_=shift @lines;
- $line++;
- chomp;
+ $_=$nextline->();
+
+ if (! $trusted && /[[:cntrl:]]/) {
+ $trusterror->("illegal control character");
+ }
+
next if /^\s*\#/ || /^\s*$/;
if (/^\[([^\]]*)\]\s*$/) {
$section=$1;
if (! is_trusted_repo($section) ||
$section eq 'ALIAS' ||
$section eq 'DEFAULT') {
- trusterror("mr: illegal section \"[$section]\"", $f, $line, $bootstrap_url)
+ $trusterror->("illegal section \"[$section]\"");
}
}
$section=expandenv($section) if $trusted;
# continued value
while (@lines && $lines[0]=~/^\s(.+)/) {
- shift(@lines);
- $line++;
$value.="\n$1";
chomp $value;
+ $nextline->();
}
if (! $trusted) {
# settings in specific known-safe formats.
if ($parameter eq 'checkout') {
if (! is_trusted_checkout($value)) {
- trusterror("mr: illegal checkout command \"$value\"", $f, $line, $bootstrap_url);
+ $trusterror->("illegal checkout command \"$value\"");
}
}
elsif ($parameter eq 'order') {
# safe.
}
else {
- trusterror("mr: illegal setting \"$parameter=$value\"", $f, $line, $bootstrap_url);
+ $trusterror->("illegal setting \"$parameter=$value\"");
}
}
if ($parameter eq "include") {
print "mr: including output of \"$value\"\n" if $verbose;
- unshift @lines, `$value`;
+ my @inc=`$value`;
if ($?) {
print STDERR "mr: include command exited nonzero ($?)\n";
}
+ $included += @inc;
+ unshift @lines, @inc;
next;
}
if (! defined $section) {
- die "$f line $.: parameter ($parameter) not in section\n";
+ $lineerror->("parameter ($parameter) not in section");
}
if ($section eq 'ALIAS') {
$alias{$parameter}=$value;
}
- elsif ($parameter eq 'lib') {
- $config{$dir}{$section}{lib}.=$value."\n";
+ elsif ($parameter eq 'lib' or $parameter =~ s/_append$//) {
+ $config{$dir}{$section}{$parameter}.="\n".$value."\n";
}
else {
$config{$dir}{$section}{$parameter}=$value;
if ($parameter eq 'chain' &&
length $dir && $section ne "DEFAULT") {
my $chaindir="$section";
- if ($chaindir !~ m!/!) {
+ if ($chaindir !~ m!^/!) {
$chaindir=$dir.$chaindir;
}
if (-e "$chaindir/.mrconfig") {
}
}
else {
- die "$f line $line: parse error\n";
+ $lineerror->("parse error");
}
}
right = echo "Not found."
# vim:sw=8:sts=0:ts=8:noet
+# Local variables:
+# indent-tabs-mode: t
+# cperl-indent-level: 8
+# End:
projects / code / myrepos.git / blobdiff