Documentation/git-pull: describe default behaviour and config interactions
[git/mingw/j6t.git] / git-remote.perl
blobc56c5a84a4ac67648efd3c5ccf690e9cb21dd54f
1 #!/usr/bin/perl -w
3 use Git;
4 my $git = Git->repository();
6 sub add_remote_config {
7 my ($hash, $name, $what, $value) = @_;
8 if ($what eq 'url') {
9 if (exists $hash->{$name}{'URL'}) {
10 print STDERR "Warning: more than one remote.$name.url\n";
12 $hash->{$name}{'URL'} = $value;
14 elsif ($what eq 'fetch') {
15 $hash->{$name}{'FETCH'} ||= [];
16 push @{$hash->{$name}{'FETCH'}}, $value;
18 if (!exists $hash->{$name}{'SOURCE'}) {
19 $hash->{$name}{'SOURCE'} = 'config';
23 sub add_remote_remotes {
24 my ($hash, $file, $name) = @_;
26 if (exists $hash->{$name}) {
27 $hash->{$name}{'WARNING'} = 'ignored due to config';
28 return;
31 my $fh;
32 if (!open($fh, '<', $file)) {
33 print STDERR "Warning: cannot open $file\n";
34 return;
36 my $it = { 'SOURCE' => 'remotes' };
37 $hash->{$name} = $it;
38 while (<$fh>) {
39 chomp;
40 if (/^URL:\s*(.*)$/) {
41 # Having more than one is Ok -- it is used for push.
42 if (! exists $it->{'URL'}) {
43 $it->{'URL'} = $1;
46 elsif (/^Push:\s*(.*)$/) {
47 ; # later
49 elsif (/^Pull:\s*(.*)$/) {
50 $it->{'FETCH'} ||= [];
51 push @{$it->{'FETCH'}}, $1;
53 elsif (/^\#/) {
54 ; # ignore
56 else {
57 print STDERR "Warning: funny line in $file: $_\n";
60 close($fh);
63 sub list_remote {
64 my ($git) = @_;
65 my %seen = ();
66 my @remotes = eval {
67 $git->command(qw(config --get-regexp), '^remote\.');
69 for (@remotes) {
70 if (/^remote\.([^.]*)\.(\S*)\s+(.*)$/) {
71 add_remote_config(\%seen, $1, $2, $3);
75 my $dir = $git->repo_path() . "/remotes";
76 if (opendir(my $dh, $dir)) {
77 local $_;
78 while ($_ = readdir($dh)) {
79 chomp;
80 next if (! -f "$dir/$_" || ! -r _);
81 add_remote_remotes(\%seen, "$dir/$_", $_);
85 return \%seen;
88 sub add_branch_config {
89 my ($hash, $name, $what, $value) = @_;
90 if ($what eq 'remote') {
91 if (exists $hash->{$name}{'REMOTE'}) {
92 print STDERR "Warning: more than one branch.$name.remote\n";
94 $hash->{$name}{'REMOTE'} = $value;
96 elsif ($what eq 'merge') {
97 $hash->{$name}{'MERGE'} ||= [];
98 push @{$hash->{$name}{'MERGE'}}, $value;
102 sub list_branch {
103 my ($git) = @_;
104 my %seen = ();
105 my @branches = eval {
106 $git->command(qw(config --get-regexp), '^branch\.');
108 for (@branches) {
109 if (/^branch\.([^.]*)\.(\S*)\s+(.*)$/) {
110 add_branch_config(\%seen, $1, $2, $3);
114 return \%seen;
117 my $remote = list_remote($git);
118 my $branch = list_branch($git);
120 sub update_ls_remote {
121 my ($harder, $info) = @_;
123 return if (($harder == 0) ||
124 (($harder == 1) && exists $info->{'LS_REMOTE'}));
126 my @ref = map {
127 s|^[0-9a-f]{40}\s+refs/heads/||;
129 } $git->command(qw(ls-remote --heads), $info->{'URL'});
130 $info->{'LS_REMOTE'} = \@ref;
133 sub list_wildcard_mapping {
134 my ($forced, $ours, $ls) = @_;
135 my %refs;
136 for (@$ls) {
137 $refs{$_} = 01; # bit #0 to say "they have"
139 for ($git->command('for-each-ref', "refs/remotes/$ours")) {
140 chomp;
141 next unless (s|^[0-9a-f]{40}\s[a-z]+\srefs/remotes/$ours/||);
142 next if ($_ eq 'HEAD');
143 $refs{$_} ||= 0;
144 $refs{$_} |= 02; # bit #1 to say "we have"
146 my (@new, @stale, @tracked);
147 for (sort keys %refs) {
148 my $have = $refs{$_};
149 if ($have == 1) {
150 push @new, $_;
152 elsif ($have == 2) {
153 push @stale, $_;
155 elsif ($have == 3) {
156 push @tracked, $_;
159 return \@new, \@stale, \@tracked;
162 sub list_mapping {
163 my ($name, $info) = @_;
164 my $fetch = $info->{'FETCH'};
165 my $ls = $info->{'LS_REMOTE'};
166 my (@new, @stale, @tracked);
168 for (@$fetch) {
169 next unless (/(\+)?([^:]+):(.*)/);
170 my ($forced, $theirs, $ours) = ($1, $2, $3);
171 if ($theirs eq 'refs/heads/*' &&
172 $ours =~ /^refs\/remotes\/(.*)\/\*$/) {
173 # wildcard mapping
174 my ($w_new, $w_stale, $w_tracked)
175 = list_wildcard_mapping($forced, $1, $ls);
176 push @new, @$w_new;
177 push @stale, @$w_stale;
178 push @tracked, @$w_tracked;
180 elsif ($theirs =~ /\*/ || $ours =~ /\*/) {
181 print STDERR "Warning: unrecognized mapping in remotes.$name.fetch: $_\n";
183 elsif ($theirs =~ s|^refs/heads/||) {
184 if (!grep { $_ eq $theirs } @$ls) {
185 push @stale, $theirs;
187 elsif ($ours ne '') {
188 push @tracked, $theirs;
192 return \@new, \@stale, \@tracked;
195 sub show_mapping {
196 my ($name, $info) = @_;
197 my ($new, $stale, $tracked) = list_mapping($name, $info);
198 if (@$new) {
199 print " New remote branches (next fetch will store in remotes/$name)\n";
200 print " @$new\n";
202 if (@$stale) {
203 print " Stale tracking branches in remotes/$name (use 'git remote prune')\n";
204 print " @$stale\n";
206 if (@$tracked) {
207 print " Tracked remote branches\n";
208 print " @$tracked\n";
212 sub prune_remote {
213 my ($name, $ls_remote) = @_;
214 if (!exists $remote->{$name}) {
215 print STDERR "No such remote $name\n";
216 return;
218 my $info = $remote->{$name};
219 update_ls_remote($ls_remote, $info);
221 my ($new, $stale, $tracked) = list_mapping($name, $info);
222 my $prefix = "refs/remotes/$name";
223 foreach my $to_prune (@$stale) {
224 my @v = $git->command(qw(rev-parse --verify), "$prefix/$to_prune");
225 $git->command(qw(update-ref -d), "$prefix/$to_prune", $v[0]);
229 sub show_remote {
230 my ($name, $ls_remote) = @_;
231 if (!exists $remote->{$name}) {
232 print STDERR "No such remote $name\n";
233 return;
235 my $info = $remote->{$name};
236 update_ls_remote($ls_remote, $info);
238 print "* remote $name\n";
239 print " URL: $info->{'URL'}\n";
240 for my $branchname (sort keys %$branch) {
241 next if ($branch->{$branchname}{'REMOTE'} ne $name);
242 my @merged = map {
243 s|^refs/heads/||;
245 } split(' ',"@{$branch->{$branchname}{'MERGE'}}");
246 next unless (@merged);
247 print " Remote branch(es) merged with 'git pull' while on branch $branchname\n";
248 print " @merged\n";
250 if ($info->{'LS_REMOTE'}) {
251 show_mapping($name, $info);
255 sub add_remote {
256 my ($name, $url, $opts) = @_;
257 if (exists $remote->{$name}) {
258 print STDERR "remote $name already exists.\n";
259 exit(1);
261 $git->command('config', "remote.$name.url", $url);
262 my $track = $opts->{'track'} || ["*"];
264 for (@$track) {
265 $git->command('config', '--add', "remote.$name.fetch",
266 "+refs/heads/$_:refs/remotes/$name/$_");
268 if ($opts->{'fetch'}) {
269 $git->command('fetch', $name);
271 if (exists $opts->{'master'}) {
272 $git->command('symbolic-ref', "refs/remotes/$name/HEAD",
273 "refs/remotes/$name/$opts->{'master'}");
277 sub add_usage {
278 print STDERR "Usage: git remote add [-f] [-t track]* [-m master] <name> <url>\n";
279 exit(1);
282 if (!@ARGV) {
283 for (sort keys %$remote) {
284 print "$_\n";
287 elsif ($ARGV[0] eq 'show') {
288 my $ls_remote = 1;
289 my $i;
290 for ($i = 1; $i < @ARGV; $i++) {
291 if ($ARGV[$i] eq '-n') {
292 $ls_remote = 0;
294 else {
295 last;
298 if ($i >= @ARGV) {
299 print STDERR "Usage: git remote show <remote>\n";
300 exit(1);
302 for (; $i < @ARGV; $i++) {
303 show_remote($ARGV[$i], $ls_remote);
306 elsif ($ARGV[0] eq 'prune') {
307 my $ls_remote = 1;
308 my $i;
309 for ($i = 1; $i < @ARGV; $i++) {
310 if ($ARGV[$i] eq '-n') {
311 $ls_remote = 0;
313 else {
314 last;
317 if ($i >= @ARGV) {
318 print STDERR "Usage: git remote prune <remote>\n";
319 exit(1);
321 for (; $i < @ARGV; $i++) {
322 prune_remote($ARGV[$i], $ls_remote);
325 elsif ($ARGV[0] eq 'add') {
326 my %opts = ();
327 while (1 < @ARGV && $ARGV[1] =~ /^-/) {
328 my $opt = $ARGV[1];
329 shift @ARGV;
330 if ($opt eq '-f' || $opt eq '--fetch') {
331 $opts{'fetch'} = 1;
332 next;
334 if ($opt eq '-t' || $opt eq '--track') {
335 if (@ARGV < 1) {
336 add_usage();
338 $opts{'track'} ||= [];
339 push @{$opts{'track'}}, $ARGV[1];
340 shift @ARGV;
341 next;
343 if ($opt eq '-m' || $opt eq '--master') {
344 if ((@ARGV < 1) || exists $opts{'master'}) {
345 add_usage();
347 $opts{'master'} = $ARGV[1];
348 shift @ARGV;
349 next;
351 add_usage();
353 if (@ARGV != 3) {
354 add_usage();
356 add_remote($ARGV[1], $ARGV[2], \%opts);
358 else {
359 print STDERR "Usage: git remote\n";
360 print STDERR " git remote add <name> <url>\n";
361 print STDERR " git remote show <name>\n";
362 print STDERR " git remote prune <name>\n";
363 exit(1);