]> git.vpit.fr Git - perl/modules/rgit.git/blob - README
This is 0.03
[perl/modules/rgit.git] / README
1 NAME
2     rgit - Recursively execute a command on all the git repositories in a
3     directory tree.
4
5 VERSION
6     Version 0.03
7
8 SYNOPSIS
9         rgit [GIT_OPTIONS] COMMAND [COMMAND_ARGS]
10
11 DESCRIPTION
12     This utility recursively searches in the current directory (or in the
13     directory given by the "GIT_DIR" environment variable if it's set) for
14     all git repositories, sort this list by the repository path, "chdir"
15     into each of them, and executes the specified git command. Moreover,
16     those formats are substuted in the arguments before running the command
17     :
18
19     *   "^n" with the current repository name.
20
21     *   "^g" with the relative path to the current repository.
22
23     *   "^G" with the absolute path to the current repository.
24
25     *   "^w" with the relative path to the current repository's working
26         directory.
27
28     *   "^W" with the absolute path to the current repository's working
29         directory.
30
31     *   "^b" with a "bareified" relative path, i.e. "^g" if this is a bare
32         repository, and "^w.git" otherwise.
33
34     *   "^B" with an absolute version of the "bareified" path.
35
36     *   "^R" with the absolute path to the current root directory.
37
38     *   "^^" with a bare "^".
39
40     There are actually a few commands that are only executed once in the
41     current directory : "version", "help", "daemon" and "init". For any of
42     those, no format substitution is done.
43
44     You can specify which "git" executable to use with the "GIT_EXEC_PATH"
45     environment variable.
46
47 EXAMPLES
48     Execute "git gc" on all the repositories below the current directory :
49
50         rgit gc
51
52     Tag all the repositories with their name :
53
54         rgit tag ^n
55
56     Add a remote to all repositories in "/foo/bar" to their bare counterpart
57     in "qux" on host :
58
59         GIT_DIR="/foo/bar" rgit remote add host git://host/qux/^b
60
61 DEPENDENCIES
62     The core modules Carp, Cwd, Exporter, File::Find, File::Spec::Functions
63     and List::Util.
64
65     Object::Tiny.
66
67 AUTHOR
68     Vincent Pit, "<perl at profvince.com>", <http://profvince.com>.
69
70     You can contact me by mail or on "irc.perl.org" (vincent).
71
72 BUGS
73     Please report any bugs or feature requests to "bug-rgit at rt.cpan.org",
74     or through the web interface at
75     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=rgit>. I will be
76     notified, and then you'll automatically be notified of progress on your
77     bug as I make changes.
78
79 SUPPORT
80     You can find documentation for this module with the perldoc command.
81
82         perldoc rgit
83
84     Tests code coverage report is available at
85     <http://www.profvince.com/perl/cover/rgit>.
86
87 COPYRIGHT & LICENSE
88     Copyright 2008 Vincent Pit, all rights reserved.
89
90     This program is free software; you can redistribute it and/or modify it
91     under the same terms as Perl itself.
92