help = 'exports a series of patches to <dir> (or patches)'
-usage = """%prog [options] [<dir>]"""
+usage = """%prog [options] [<dir>]
+
+Export the applied patches into a given directory (defaults to
+'patches') in a standard unified GNU diff format. A template file
+(defaulting to '.git/patchexport.tmpl or
+/usr/share/stgit/templates/patchexport.tmpl') can be used for the
+patch format. The following variables are supported in the template
+file:
+
+ %(description)s - patch description
+ %(shortdescr)s - the first line of the patch description
+ %(longdescr)s - the rest of the patch description, after the first line
+ %(diffstat)s - the diff statistics
+ %(authname)s - author's name
+ %(authemail)s - author's e-mail
+ %(authdate)s - patch creation date
+ %(commname)s - committer's name
+ %(commemail)s - committer's e-mail
+
+'export' can also generate a diff for a range of patches."""
options = [make_option('-n', '--numbered',
- help = 'number the patch names',
+ help = 'prefix the patch names with order numbers',
action = 'store_true'),
make_option('-d', '--diff',
help = 'append .diff to the patch names',
help = 'Use FILE as a template'),
make_option('-r', '--range',
metavar = '[PATCH1][:[PATCH2]]',
- help = 'export patches between PATCH1 and PATCH2')]
+ help = 'export patches between PATCH1 and PATCH2'),
+ make_option('-b', '--branch',
+ help = 'use BRANCH instead of the default one'),
+ make_option('-s', '--stdout',
+ help = 'dump the patches to the standard output',
+ action = 'store_true')]
def func(parser, options, args):
if len(args) == 0:
- dirname = 'patches'
+ dirname = 'patches-%s' % crt_series.get_branch()
elif len(args) == 1:
dirname = args[0]
else:
parser.error('incorrect number of arguments')
- if git.local_changes():
+ if not options.branch and git.local_changes():
print 'Warning: local changes in the tree. ' \
'You might want to commit them first'
- if not os.path.isdir(dirname):
- os.makedirs(dirname)
- series = file(os.path.join(dirname, 'series'), 'w+')
+ if not options.stdout:
+ if not os.path.isdir(dirname):
+ os.makedirs(dirname)
+ series = file(os.path.join(dirname, 'series'), 'w+')
applied = crt_series.get_applied()
+ unapplied = crt_series.get_unapplied()
if options.range:
boundaries = options.range.split(':')
if start in applied:
start_idx = applied.index(start)
else:
- raise CmdException, 'Patch "%s" not applied' % start
+ if start in unapplied:
+ raise CmdException, 'Patch "%s" not applied' % start
+ else:
+ raise CmdException, 'Patch "%s" does not exist' % start
+
if stop in applied:
stop_idx = applied.index(stop) + 1
else:
- raise CmdException, 'Patch "%s" not applied' % stop
+ if stop in unapplied:
+ raise CmdException, 'Patch "%s" not applied' % stop
+ else:
+ raise CmdException, 'Patch "%s" does not exist' % stop
if start_idx >= stop_idx:
raise CmdException, 'Incorrect patch range order'
patches = applied[start_idx:stop_idx]
num = len(patches)
+ if num == 0:
+ raise CmdException, 'No patches applied'
+
zpadding = len(str(num))
if zpadding < 2:
zpadding = 2
+ # get the template
+ if options.template:
+ patch_tmpl_list = [options.template]
+ else:
+ patch_tmpl_list = []
+
+ patch_tmpl_list += [os.path.join(git.get_base_dir(), 'patchexport.tmpl'),
+ os.path.join(sys.prefix,
+ 'share/stgit/templates/patchexport.tmpl')]
+ tmpl = ''
+ for patch_tmpl in patch_tmpl_list:
+ if os.path.isfile(patch_tmpl):
+ tmpl = file(patch_tmpl).read()
+ break
+
+ # note the base commit for this series
+ if not options.stdout:
+ base_commit = crt_series.get_patch(patches[0]).get_bottom()
+ print >> series, '# This series applies on GIT commit %s' % base_commit
+
patch_no = 1;
for p in patches:
pname = p
if options.numbered:
pname = '%s-%s' % (str(patch_no).zfill(zpadding), pname)
pfile = os.path.join(dirname, pname)
- print >> series, pname
-
- # get the template
- if options.template:
- patch_tmpl = options.template
- else:
- patch_tmpl = os.path.join(git.base_dir, 'patchexport.tmpl')
- if os.path.isfile(patch_tmpl):
- tmpl = file(patch_tmpl).read()
- else:
- tmpl = ''
+ if not options.stdout:
+ print >> series, pname
# get the patch description
patch = crt_series.get_patch(p)
+ descr = patch.get_description().strip()
+ descr_lines = descr.split('\n')
+
+ short_descr = descr_lines[0].rstrip()
+ long_descr = reduce(lambda x, y: x + '\n' + y,
+ descr_lines[1:], '').strip()
+
tmpl_dict = {'description': patch.get_description().rstrip(),
- 'diffstat': git.diffstat(rev1 = git_id('%s/bottom' % p),
- rev2 = git_id('%s/top' % p)),
+ 'shortdescr': short_descr,
+ 'longdescr': long_descr,
+ 'diffstat': git.diffstat(rev1 = patch.get_bottom(),
+ rev2 = patch.get_top()),
'authname': patch.get_authname(),
'authemail': patch.get_authemail(),
'authdate': patch.get_authdate(),
except TypeError:
raise CmdException, 'Only "%(name)s" variables are ' \
'supported in the patch template'
- f = open(pfile, 'w+')
- f.write(descr)
+ if options.stdout:
+ f = sys.stdout
+ else:
+ f = open(pfile, 'w+')
+
+ if options.stdout and num > 1:
+ print '-------------------------------------------------------------------------------'
+ print patch.get_name()
+ print '-------------------------------------------------------------------------------'
+
+ # write description
+ f.write(descr)
# write the diff
- git.diff(rev1 = git_id('%s/bottom' % p),
- rev2 = git_id('%s/top' % p),
+ git.diff(rev1 = patch.get_bottom(),
+ rev2 = patch.get_top(),
out_fd = f)
- f.close()
+ if not options.stdout:
+ f.close()
patch_no += 1
- series.close()
+ if not options.stdout:
+ series.close()
~mdw / stgit / blobdiff