Better "stg rebase" help text
[stgit] / stgit / commands / rebase.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 = 'move the stack base to another point in history'
27 usage = """%prog [options] <new-base-id>
28
29 Pop all patches from current stack, move the stack base to the given
30 <new-base-id> and push the patches back.
31
32 If you experience merge conflicts, resolve the problem and continue
33 the rebase by executing the following sequence:
34
35 $ stg resolved -a [-i]
36 $ stg refresh
37 $ stg goto top-patch
38
39 Or if you want to skip that patch:
40
41 $ stg push --undo
42 $ stg push next-patch..top-patch"""
43
44 directory = DirectoryGotoToplevel()
45 options = [make_option('-n', '--nopush',
46 help = 'do not push the patches back after rebasing',
47 action = 'store_true'),
48 make_option('-m', '--merged',
49 help = 'check for patches merged upstream',
50 action = 'store_true')]
51
52 def func(parser, options, args):
53 """Rebase the current stack
54 """
55 if len(args) != 1:
56 parser.error('incorrect number of arguments')
57
58 if crt_series.get_protected():
59 raise CmdException, 'This branch is protected. Rebase is not permitted'
60
61 check_local_changes()
62 check_conflicts()
63 check_head_top_equal(crt_series)
64
65 # ensure an exception is raised before popping on non-existent target
66 if git_id(crt_series, args[0]) == None:
67 raise GitException, 'Unknown revision: %s' % args[0]
68
69 applied = prepare_rebase(crt_series)
70 rebase(crt_series, args[0])
71 post_rebase(crt_series, applied, options.nopush, options.merged)
72
73 print_crt_patch(crt_series)