Improve the help message for commands
[stgit] / stgit / commands / pop.py
1
2 __copyright__ = """
3 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License version 2 as
7 published by the Free Software Foundation.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 """
18
19 import sys, os
20 from optparse import OptionParser, make_option
21
22 from stgit.commands.common import *
23 from stgit.utils import *
24 from stgit import stack, git
25
26
27 help = 'pop the top of the series'
28 usage = """%prog [options]
29
30 Pop the topmost patch or a range of patches starting with the topmost
31 one from the stack. The command fails if there are local changes or
32 conflicts."""
33
34 options = [make_option('-a', '--all',
35 help = 'pop all the applied patches',
36 action = 'store_true'),
37 make_option('-n', '--number', type = 'int',
38 help = 'pop the specified number of patches'),
39 make_option('-t', '--to', metavar = 'PATCH',
40 help = 'pop all patches up to PATCH')]
41
42
43 def func(parser, options, args):
44 """Pop the topmost patch from the stack
45 """
46 if len(args) != 0:
47 parser.error('incorrect number of arguments')
48
49 check_local_changes()
50 check_conflicts()
51 check_head_top_equal()
52
53 applied = crt_series.get_applied()
54 if not applied:
55 raise CmdException, 'No patches applied'
56 applied.reverse()
57
58 if options.to:
59 if options.to not in applied:
60 raise CmdException, 'Patch "%s" not applied' % options.to
61 patches = applied[:applied.index(options.to)]
62 elif options.number:
63 patches = applied[:options.number]
64 elif options.all:
65 patches = applied
66 else:
67 patches = [applied[0]]
68
69 if patches == []:
70 raise CmdException, 'No patches to pop'
71
72 # pop everything to the given patch
73 p = patches[-1]
74 if len(patches) == 1:
75 print 'Popping patch "%s"...' % p,
76 else:
77 print 'Popping "%s" - "%s" patches...' % (patches[0], p),
78 sys.stdout.flush()
79
80 crt_series.pop_patch(p)
81
82 print 'done'
83 print_crt_patch()