5 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License version 2 as
9 published by the Free Software Foundation.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 from optparse
import OptionParser
, make_option
24 from stgit
.commands
.common
import *
25 from stgit
.utils
import *
26 from stgit
import stack
, git
29 help = 'exports a series of patches to <dir> (or patches)'
30 usage
= """%prog [options] [<dir>]
32 Export the applied patches into a given directory (defaults to
33 'patches') in a standard unified GNU diff format. A template file
34 (defaulting to '.git/patchexport.tmpl or
35 /usr/share/stgit/templates/patchexport.tmpl') can be used for the
36 patch format. The following variables are supported in the template
39 %(description)s - patch description
40 %(shortdescr)s - the first line of the patch description
41 %(longdescr)s - the rest of the patch description, after the first line
42 %(diffstat)s - the diff statistics
43 %(authname)s - author's name
44 %(authemail)s - author's e-mail
45 %(authdate)s - patch creation date
46 %(commname)s - committer's name
47 %(commemail)s - committer's e-mail
49 'export' can also generate a diff for a range of patches."""
51 options
= [make_option('-n', '--numbered',
52 help = 'prefix the patch names with order numbers',
53 action
= 'store_true'),
54 make_option('-d', '--diff',
55 help = 'append .diff to the patch names',
56 action
= 'store_true'),
57 make_option('-t', '--template', metavar
= 'FILE',
58 help = 'Use FILE as a template'),
59 make_option('-r', '--range',
60 metavar
= '[PATCH1][:[PATCH2]]',
61 help = 'export patches between PATCH1 and PATCH2'),
62 make_option('-b', '--branch',
63 help = 'use BRANCH instead of the default one')]
66 def func(parser
, options
, args
):
68 dirname
= 'patches-%s' % crt_series
.get_branch()
72 parser
.error('incorrect number of arguments')
74 if not options
.branch
and git
.local_changes():
75 print 'Warning: local changes in the tree. ' \
76 'You might want to commit them first'
78 if not os
.path
.isdir(dirname
):
80 series
= file(os
.path
.join(dirname
, 'series'), 'w+')
82 applied
= crt_series
.get_applied()
83 unapplied
= crt_series
.get_unapplied()
86 boundaries
= options
.range.split(':')
87 if len(boundaries
) == 1:
90 elif len(boundaries
) == 2:
91 if boundaries
[0] == '':
95 if boundaries
[1] == '':
100 raise CmdException
, 'incorrect parameters to "--range"'
103 start_idx
= applied
.index(start
)
105 if start
in unapplied
:
106 raise CmdException
, 'Patch "%s" not applied' % start
108 raise CmdException
, 'Patch "%s" does not exist' % start
111 stop_idx
= applied
.index(stop
) + 1
113 if stop
in unapplied
:
114 raise CmdException
, 'Patch "%s" not applied' % stop
116 raise CmdException
, 'Patch "%s" does not exist' % stop
118 if start_idx
>= stop_idx
:
119 raise CmdException
, 'Incorrect patch range order'
122 stop_idx
= len(applied
)
124 patches
= applied
[start_idx
:stop_idx
]
128 raise CmdException
, 'No patches applied'
130 zpadding
= len(str(num
))
136 patch_tmpl_list
= [options
.template
]
140 patch_tmpl_list
+= [os
.path
.join(git
.get_base_dir(), 'patchexport.tmpl'),
141 os
.path
.join(sys
.prefix
,
142 'share/stgit/templates/patchexport.tmpl')]
144 for patch_tmpl
in patch_tmpl_list
:
145 if os
.path
.isfile(patch_tmpl
):
146 tmpl
= file(patch_tmpl
).read()
149 # note the base commit for this series
150 base_commit
= crt_series
.get_patch(patches
[0]).get_bottom()
151 print >> series
, '# This series applies on GIT commit %s' % base_commit
157 pname
= '%s.diff' % pname
159 pname
= '%s-%s' %
(str(patch_no
).zfill(zpadding
), pname
)
160 pfile
= os
.path
.join(dirname
, pname
)
161 print >> series
, pname
163 # get the patch description
164 patch
= crt_series
.get_patch(p
)
166 descr
= patch
.get_description().strip()
167 descr_lines
= descr
.split('\n')
169 short_descr
= descr_lines
[0].rstrip()
170 long_descr
= reduce(lambda x
, y
: x
+ '\n' + y
,
171 descr_lines
[1:], '').strip()
173 tmpl_dict
= {'description': patch
.get_description().rstrip(),
174 'shortdescr': short_descr
,
175 'longdescr': long_descr
,
176 'diffstat': git
.diffstat(rev1
= patch
.get_bottom(),
177 rev2
= patch
.get_top()),
178 'authname': patch
.get_authname(),
179 'authemail': patch
.get_authemail(),
180 'authdate': patch
.get_authdate(),
181 'commname': patch
.get_commname(),
182 'commemail': patch
.get_commemail()}
183 for key
in tmpl_dict
:
184 if not tmpl_dict
[key
]:
188 descr
= tmpl % tmpl_dict
189 except KeyError, err
:
190 raise CmdException
, 'Unknown patch template variable: %s' \
193 raise CmdException
, 'Only "%(name)s" variables are ' \
194 'supported in the patch template'
195 f
= open(pfile
, 'w+')
199 git
.diff(rev1
= patch
.get_bottom(),
200 rev2
= patch
.get_top(),