'sync' code comments clean-up after commit 6b79a09c
[stgit] / stgit / commands / sync.py
1 __copyright__ = """
2 Copyright (C) 2006, 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 import stgit.commands.common
22 from stgit.commands.common import *
23 from stgit.utils import *
24 from stgit import stack, git
25
26
27 help = 'synchronise patches with a branch or a series'
28 usage = """%prog [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]
29
30 For each of the specified patches perform a three-way merge with the
31 same patch in the specified branch or series. The command can be used
32 for keeping patches on several branches in sync. Note that the
33 operation may fail for some patches because of conflicts. The patches
34 in the series must apply cleanly.
35
36 The sync operation can be reverted for individual patches with --undo."""
37
38 options = [make_option('-a', '--all',
39 help = 'synchronise all the patches',
40 action = 'store_true'),
41 make_option('-B', '--ref-branch',
42 help = 'syncronise patches with BRANCH'),
43 make_option('-s', '--series',
44 help = 'syncronise patches with SERIES'),
45 make_option('--undo',
46 help = 'undo the synchronisation of the current patch',
47 action = 'store_true')]
48
49 def __check_all():
50 check_local_changes()
51 check_conflicts()
52 check_head_top_equal()
53
54 def __branch_merge_patch(remote_series, pname):
55 """Merge a patch from a remote branch into the current tree.
56 """
57 patch = remote_series.get_patch(pname)
58 git.merge(patch.get_bottom(), git.get_head(), patch.get_top())
59
60 def __series_merge_patch(base, patchdir, pname):
61 """Merge a patch file with the given StGIT patch.
62 """
63 patchfile = os.path.join(patchdir, pname)
64 git.apply_patch(filename = patchfile, base = base)
65
66 def func(parser, options, args):
67 """Synchronise a range of patches
68 """
69 if options.undo:
70 if options.ref_branch or options.series:
71 raise CmdException, \
72 '--undo cannot be specified with --ref-branch or --series'
73 __check_all()
74
75 out.start('Undoing the sync of "%s"' % crt_series.get_current())
76 crt_series.undo_refresh()
77 git.reset()
78 out.done()
79 return
80
81 if options.ref_branch:
82 remote_series = stack.Series(options.ref_branch)
83 if options.ref_branch == crt_series.get_name():
84 raise CmdException, 'Cannot synchronise with the current branch'
85 remote_patches = remote_series.get_applied()
86
87 # the merge function merge_patch(patch, pname)
88 merge_patch = lambda patch, pname: \
89 __branch_merge_patch(remote_series, pname)
90 elif options.series:
91 patchdir = os.path.dirname(options.series)
92
93 remote_patches = []
94 f = file(options.series)
95 for line in f:
96 p = re.sub('#.*$', '', line).strip()
97 if not p:
98 continue
99 remote_patches.append(p)
100 f.close()
101
102 # the merge function merge_patch(patch, pname)
103 merge_patch = lambda patch, pname: \
104 __series_merge_patch(patch.get_bottom(), patchdir, pname)
105 else:
106 raise CmdException, 'No remote branch or series specified'
107
108 applied = crt_series.get_applied()
109
110 if options.all:
111 patches = applied
112 elif len(args) != 0:
113 patches = parse_patches(args, applied, ordered = True)
114 elif applied:
115 patches = [crt_series.get_current()]
116 else:
117 parser.error('no patches applied')
118
119 if not patches:
120 raise CmdException, 'No patches to synchronise'
121
122 __check_all()
123
124 # only keep the patches to be synchronised
125 sync_patches = [p for p in patches if p in remote_patches]
126 if not sync_patches:
127 raise CmdException, 'No common patches to be synchronised'
128
129 # pop to the one before the first patch to be synchronised
130 popped = applied[applied.index(sync_patches[0]) + 1:]
131 if popped:
132 pop_patches(popped[::-1])
133
134 for p in sync_patches:
135 if p in popped:
136 # push to this patch
137 idx = popped.index(p) + 1
138 push_patches(popped[:idx])
139 del popped[:idx]
140
141 # the actual sync
142 out.start('Synchronising "%s"' % p)
143
144 patch = crt_series.get_patch(p)
145 bottom = patch.get_bottom()
146 top = patch.get_top()
147
148 # reset the patch backup information. That's needed in case we
149 # undo the sync but there were no changes made
150 patch.set_bottom(bottom, backup = True)
151 patch.set_top(top, backup = True)
152
153 # the actual merging (either from a branch or an external file)
154 merge_patch(patch, p)
155
156 if git.local_changes(verbose = False):
157 # index (cache) already updated by the git merge. The
158 # backup information was already reset above
159 crt_series.refresh_patch(cache_update = False, backup = False,
160 log = 'sync')
161 out.done('updated')
162 else:
163 out.done()
164
165 # push the remaining patches
166 if popped:
167 push_patches(popped)