Commit | Line | Data |
---|---|---|
fcee87cf CM |
1 | """Export command |
2 | """ | |
3 | ||
4 | __copyright__ = """ | |
5 | Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com> | |
6 | ||
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. | |
10 | ||
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. | |
15 | ||
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 | |
19 | """ | |
20 | ||
21 | import sys, os | |
22 | from optparse import OptionParser, make_option | |
23 | ||
24 | from stgit.commands.common import * | |
25 | from stgit.utils import * | |
1f3bb017 | 26 | from stgit import stack, git, templates |
fcee87cf CM |
27 | |
28 | ||
29 | help = 'exports a series of patches to <dir> (or patches)' | |
26aab5b0 CM |
30 | usage = """%prog [options] [<dir>] |
31 | ||
32 | Export the applied patches into a given directory (defaults to | |
23a88c7d | 33 | 'patches') in a standard unified GNU diff format. A template file |
94d18868 YD |
34 | (defaulting to '.git/patchexport.tmpl' or |
35 | '~/.stgit/templates/patchexport.tmpl' or | |
36 | '/usr/share/stgit/templates/patchexport.tmpl') can be used for the | |
23a88c7d CM |
37 | patch format. The following variables are supported in the template |
38 | file: | |
26aab5b0 CM |
39 | |
40 | %(description)s - patch description | |
99e73103 CM |
41 | %(shortdescr)s - the first line of the patch description |
42 | %(longdescr)s - the rest of the patch description, after the first line | |
26aab5b0 CM |
43 | %(diffstat)s - the diff statistics |
44 | %(authname)s - author's name | |
45 | %(authemail)s - author's e-mail | |
46 | %(authdate)s - patch creation date | |
47 | %(commname)s - committer's name | |
48 | %(commemail)s - committer's e-mail | |
49 | ||
50 | 'export' can also generate a diff for a range of patches.""" | |
fcee87cf CM |
51 | |
52 | options = [make_option('-n', '--numbered', | |
26aab5b0 | 53 | help = 'prefix the patch names with order numbers', |
fcee87cf CM |
54 | action = 'store_true'), |
55 | make_option('-d', '--diff', | |
56 | help = 'append .diff to the patch names', | |
57 | action = 'store_true'), | |
099ff6cd CM |
58 | make_option('-p', '--patch', |
59 | help = 'append .patch to the patch names', | |
60 | action = 'store_true'), | |
fcee87cf CM |
61 | make_option('-t', '--template', metavar = 'FILE', |
62 | help = 'Use FILE as a template'), | |
63 | make_option('-r', '--range', | |
6b1e0111 | 64 | metavar = '[PATCH1][..[PATCH2]]', |
2f7c8b0b CM |
65 | help = 'export patches between PATCH1 and PATCH2'), |
66 | make_option('-b', '--branch', | |
1fceece7 CM |
67 | help = 'use BRANCH instead of the default one'), |
68 | make_option('-s', '--stdout', | |
69 | help = 'dump the patches to the standard output', | |
70 | action = 'store_true')] | |
fcee87cf CM |
71 | |
72 | ||
73 | def func(parser, options, args): | |
74 | if len(args) == 0: | |
629ddd02 | 75 | dirname = 'patches-%s' % crt_series.get_branch() |
fcee87cf CM |
76 | elif len(args) == 1: |
77 | dirname = args[0] | |
78 | else: | |
79 | parser.error('incorrect number of arguments') | |
80 | ||
2f7c8b0b | 81 | if not options.branch and git.local_changes(): |
fcee87cf CM |
82 | print 'Warning: local changes in the tree. ' \ |
83 | 'You might want to commit them first' | |
84 | ||
1fceece7 CM |
85 | if not options.stdout: |
86 | if not os.path.isdir(dirname): | |
87 | os.makedirs(dirname) | |
88 | series = file(os.path.join(dirname, 'series'), 'w+') | |
fcee87cf CM |
89 | |
90 | applied = crt_series.get_applied() | |
91 | ||
92 | if options.range: | |
6b1e0111 | 93 | patches = parse_patches([options.range], applied) |
fcee87cf | 94 | else: |
6b1e0111 | 95 | patches = applied |
fcee87cf CM |
96 | |
97 | num = len(patches) | |
16ad223e PR |
98 | if num == 0: |
99 | raise CmdException, 'No patches applied' | |
100 | ||
fcee87cf CM |
101 | zpadding = len(str(num)) |
102 | if zpadding < 2: | |
103 | zpadding = 2 | |
104 | ||
23a88c7d CM |
105 | # get the template |
106 | if options.template: | |
1f3bb017 | 107 | tmpl = file(options.template).read() |
23a88c7d | 108 | else: |
1f3bb017 CM |
109 | tmpl = templates.get_template('patchexport.tmpl') |
110 | if not tmpl: | |
111 | tmpl = '' | |
23a88c7d | 112 | |
6c4e4b68 | 113 | # note the base commit for this series |
1fceece7 CM |
114 | if not options.stdout: |
115 | base_commit = crt_series.get_patch(patches[0]).get_bottom() | |
116 | print >> series, '# This series applies on GIT commit %s' % base_commit | |
6c4e4b68 | 117 | |
fcee87cf CM |
118 | patch_no = 1; |
119 | for p in patches: | |
120 | pname = p | |
121 | if options.diff: | |
122 | pname = '%s.diff' % pname | |
099ff6cd CM |
123 | elif options.patch: |
124 | pname = '%s.patch' % pname | |
fcee87cf CM |
125 | if options.numbered: |
126 | pname = '%s-%s' % (str(patch_no).zfill(zpadding), pname) | |
127 | pfile = os.path.join(dirname, pname) | |
1fceece7 CM |
128 | if not options.stdout: |
129 | print >> series, pname | |
fcee87cf | 130 | |
fcee87cf CM |
131 | # get the patch description |
132 | patch = crt_series.get_patch(p) | |
133 | ||
99e73103 CM |
134 | descr = patch.get_description().strip() |
135 | descr_lines = descr.split('\n') | |
136 | ||
137 | short_descr = descr_lines[0].rstrip() | |
138 | long_descr = reduce(lambda x, y: x + '\n' + y, | |
139 | descr_lines[1:], '').strip() | |
140 | ||
fcee87cf | 141 | tmpl_dict = {'description': patch.get_description().rstrip(), |
99e73103 CM |
142 | 'shortdescr': short_descr, |
143 | 'longdescr': long_descr, | |
ed7ec17a CM |
144 | 'diffstat': git.diffstat(rev1 = patch.get_bottom(), |
145 | rev2 = patch.get_top()), | |
fcee87cf CM |
146 | 'authname': patch.get_authname(), |
147 | 'authemail': patch.get_authemail(), | |
148 | 'authdate': patch.get_authdate(), | |
149 | 'commname': patch.get_commname(), | |
150 | 'commemail': patch.get_commemail()} | |
151 | for key in tmpl_dict: | |
152 | if not tmpl_dict[key]: | |
153 | tmpl_dict[key] = '' | |
154 | ||
155 | try: | |
156 | descr = tmpl % tmpl_dict | |
157 | except KeyError, err: | |
8f4d71da | 158 | raise CmdException, 'Unknown patch template variable: %s' \ |
fcee87cf CM |
159 | % err |
160 | except TypeError: | |
8f4d71da | 161 | raise CmdException, 'Only "%(name)s" variables are ' \ |
fcee87cf | 162 | 'supported in the patch template' |
fcee87cf | 163 | |
1fceece7 CM |
164 | if options.stdout: |
165 | f = sys.stdout | |
166 | else: | |
167 | f = open(pfile, 'w+') | |
168 | ||
169 | if options.stdout and num > 1: | |
170 | print '-------------------------------------------------------------------------------' | |
171 | print patch.get_name() | |
172 | print '-------------------------------------------------------------------------------' | |
173 | ||
174 | # write description | |
175 | f.write(descr) | |
fcee87cf | 176 | # write the diff |
ed7ec17a CM |
177 | git.diff(rev1 = patch.get_bottom(), |
178 | rev2 = patch.get_top(), | |
26dba451 | 179 | out_fd = f) |
1fceece7 CM |
180 | if not options.stdout: |
181 | f.close() | |
fcee87cf CM |
182 | patch_no += 1 |
183 | ||
1fceece7 CM |
184 | if not options.stdout: |
185 | series.close() |