mr [options] update
mr [options] status
mr [options] commit [-m ``message'']
mr [options] record [-m ``message'']
mr [options] push
mr [options] diff
mr [options] log
mr [options] bootstrap url [directory]
mr [options] register [repository]
mr [options] config section [``parameter=[value]'' ...]
mr [options] action [params ...]
mr [options] [online|offline]
mr [options] remember action [params ...]
mr cds into and operates on all registered repositories at or below your working directory. Or, if you are in a subdirectory of a repository that contains no other registered repositories, it will stay in that directory, and work on only that repository,
mr is configured by .mrconfig files, which list the repositories. It starts by reading the .mrconfig file in your home directory, and this can in turn chain load .mrconfig files from repositories.
These predefined commands should be fairly familiar to users of any revision control system:
If a repository isn't checked out yet, it will first check it out.
The optional -m parameter allows specifying a commit message.
The optional -m parameter allows specifying a commit message.
These commands are also available:
The directory will be created if it does not exist. If no directory is specified, the current directory will be used.
If the .mrconfig file includes a repository named ``.'', that is checked out into the top of the specified directory.
The mrconfig file that is modified is chosen by either the -c option, or by looking for the closest known one at or below the current directory.
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
To see the built-in library of shell functions contained in mr:
mr config DEFAULT lib
The ~/.mrconfig file is used by default. To use a different config file, use the -c option.
Actions can be abbreviated to any unambiguous substring, so ``mr st'' is equivalent to ``mr status'', and ``mr up'' is equivalent to ``mr 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 system.
If a number is specified, will recurse into repositories at most that many subdirectories deep. For example, with -n 2 it would recurse into ./src/foo, but not ./src/packages/bar.
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 yield a good speedup in updates without loading the machine too much.
[src]
checkout = svn co svn://svn.example.com/src/trunk src
chain = true
[src/linux-2.6]
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 ``#'' 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 ``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 directory where the repository is located. This is relative to the directory 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]'')
Within a section, each parameter defines a shell command to run to handle a given action. mr contains default handlers for ``update'', ``status'', ``commit'', and other standard actions. Normally you only need to specify what to do for ``checkout''.
Note that these shell commands are run in a ``set -e'' shell environment, where any additional parameters you pass are available in ``$@''. The ``checkout'' command is run in the parent of the repository directory, since the repository isn't checked out yet. All other commands 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 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 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.
A few parameters have special meanings:
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" 12
Note that if a repository is located in a subdirectory of another repository, ordering it to be processed earlier is not recommended.
Unlike all other parameters, this parameter does not need to be placed within a section.
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.
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.
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.
By default, mr trusts all mrconfig files. (This default will change in a future release!) But if you have a ~/.mrtrust file, mr will only trust mrconfig files that are listed within it. (One file per line.) All other files will be treated as untrusted.
Licensed under the GNU GPL version 2 or higher.
http://kitenet.net/~joey/code/mr/