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'),
64 make_option('-s', '--stdout',
65 help = 'dump the patches to the standard output',
66 action
= 'store_true')]
69 def func(parser
, options
, args
):
71 dirname
= 'patches-%s' % crt_series
.get_branch()
75 parser
.error('incorrect number of arguments')
77 if not options
.branch
and git
.local_changes():
78 print 'Warning: local changes in the tree. ' \
79 'You might want to commit them first'
81 if not options
.stdout
:
82 if not os
.path
.isdir(dirname
):
84 series
= file(os
.path
.join(dirname
, 'series'), 'w+')
86 applied
= crt_series
.get_applied()
87 unapplied
= crt_series
.get_unapplied()
90 boundaries
= options
.range.split(':')
91 if len(boundaries
) == 1:
94 elif len(boundaries
) == 2:
95 if boundaries
[0] == '':
99 if boundaries
[1] == '':
104 raise CmdException
, 'incorrect parameters to "--range"'
107 start_idx
= applied
.index(start
)
109 if start
in unapplied
:
110 raise CmdException
, 'Patch "%s" not applied' % start
112 raise CmdException
, 'Patch "%s" does not exist' % start
115 stop_idx
= applied
.index(stop
) + 1
117 if stop
in unapplied
:
118 raise CmdException
, 'Patch "%s" not applied' % stop
120 raise CmdException
, 'Patch "%s" does not exist' % stop
122 if start_idx
>= stop_idx
:
123 raise CmdException
, 'Incorrect patch range order'
126 stop_idx
= len(applied
)
128 patches
= applied
[start_idx
:stop_idx
]
132 raise CmdException
, 'No patches applied'
134 zpadding
= len(str(num
))
140 patch_tmpl_list
= [options
.template
]
144 patch_tmpl_list
+= [os
.path
.join(git
.get_base_dir(), 'patchexport.tmpl'),
145 os
.path
.join(sys
.prefix
,
146 'share/stgit/templates/patchexport.tmpl')]
148 for patch_tmpl
in patch_tmpl_list
:
149 if os
.path
.isfile(patch_tmpl
):
150 tmpl
= file(patch_tmpl
).read()
153 # note the base commit for this series
154 if not options
.stdout
:
155 base_commit
= crt_series
.get_patch(patches
[0]).get_bottom()
156 print >> series
, '# This series applies on GIT commit %s' % base_commit
162 pname
= '%s.diff' % pname
164 pname
= '%s-%s' %
(str(patch_no
).zfill(zpadding
), pname
)
165 pfile
= os
.path
.join(dirname
, pname
)
166 if not options
.stdout
:
167 print >> series
, pname
169 # get the patch description
170 patch
= crt_series
.get_patch(p
)
172 descr
= patch
.get_description().strip()
173 descr_lines
= descr
.split('\n')
175 short_descr
= descr_lines
[0].rstrip()
176 long_descr
= reduce(lambda x
, y
: x
+ '\n' + y
,
177 descr_lines
[1:], '').strip()
179 tmpl_dict
= {'description': patch
.get_description().rstrip(),
180 'shortdescr': short_descr
,
181 'longdescr': long_descr
,
182 'diffstat': git
.diffstat(rev1
= patch
.get_bottom(),
183 rev2
= patch
.get_top()),
184 'authname': patch
.get_authname(),
185 'authemail': patch
.get_authemail(),
186 'authdate': patch
.get_authdate(),
187 'commname': patch
.get_commname(),
188 'commemail': patch
.get_commemail()}
189 for key
in tmpl_dict
:
190 if not tmpl_dict
[key
]:
194 descr
= tmpl % tmpl_dict
195 except KeyError, err
:
196 raise CmdException
, 'Unknown patch template variable: %s' \
199 raise CmdException
, 'Only "%(name)s" variables are ' \
200 'supported in the patch template'
205 f
= open(pfile
, 'w+')
207 if options
.stdout
and num
> 1:
208 print '-------------------------------------------------------------------------------'
209 print patch
.get_name()
210 print '-------------------------------------------------------------------------------'
215 git
.diff(rev1
= patch
.get_bottom(),
216 rev2
= patch
.get_top(),
218 if not options
.stdout
:
222 if not options
.stdout
: