Improve the help message for commands
[stgit] / stgit / commands / pull.py
1 __copyright__ = """
2 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License version 2 as
6 published by the Free Software Foundation.
7
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 GNU General Public License for more details.
12
13 You should have received a copy of the GNU General Public License
14 along with this program; if not, write to the Free Software
15 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 """
17
18 import sys, os
19 from optparse import OptionParser, make_option
20
21 from stgit.commands.common import *
22 from stgit.utils import *
23 from stgit import stack, git
24
25
26 help = 'pull the changes from the remote repository'
27 usage = """%prog [options]
28
29 Pull the latest changes from the parent repository. This command works
30 by popping all the patches from the stack, pulling the changes in the
31 parent repository, setting the base of the stack to the latest parent
32 HEAD and pusing the patches back (unless '--nopush' is specified). The
33 'push' operation can fail if there are conflicts. They need to be
34 resolved and the patch pushed again. The URL of the parent repository
35 is specified in the .git/branches/<head> file.
36
37 Note that this command doesn't perform any merge operation for the
38 base of the stack, it only performs merges with the patches being
39 pushed."""
40
41 options = [make_option('-n', '--nopush',
42 help = 'do not push the patches back after pulling',
43 action = 'store_true'),
44 make_option('--head', metavar='OTHER_HEAD',
45 help = 'pull OTHER_HEAD instead of HEAD'),
46 make_option('--tag',
47 help = 'pull TAG')]
48
49
50 def func(parser, options, args):
51 """Pull the changes from a remote repository
52 """
53 if len(args) != 0:
54 parser.error('incorrect number of arguments')
55
56 check_local_changes()
57 check_conflicts()
58 check_head_top_equal()
59
60 branch = git.get_head_file()
61 location = read_string(os.path.join(git.base_dir, 'branches', branch))
62
63 print 'Pulling from "%s"...' % location
64 new_head = git.fetch(location, options.head, options.tag)
65 print 'done'
66
67 if new_head == git_id('base'):
68 print 'Branch already up-to-date'
69 else:
70 applied = crt_series.get_applied()
71
72 if len(applied) > 0:
73 print 'Popping all patches...',
74 sys.stdout.flush()
75 crt_series.pop_patch(applied[0])
76 print 'done'
77
78 git.switch(new_head)
79
80 if options.nopush:
81 applied = []
82 for p in applied:
83 print 'Pushing patch "%s"...' % p,
84 sys.stdout.flush()
85 crt_series.push_patch(p)
86 if crt_series.empty_patch(p):
87 print 'done (empty patch)'
88 else:
89 print 'done'
90
91 print_crt_patch()