Add the --patch option to export
[stgit] / stgit / commands / export.py
index 3e318a9..549145e 100644 (file)
@@ -37,6 +37,8 @@ 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
@@ -52,13 +54,19 @@ options = [make_option('-n', '--numbered',
            make_option('-d', '--diff',
                        help = 'append .diff to the patch names',
                        action = 'store_true'),
+           make_option('-p', '--patch',
+                       help = 'append .patch to the patch names',
+                       action = 'store_true'),
            make_option('-t', '--template', metavar = 'FILE',
                        help = 'Use FILE as a template'),
            make_option('-r', '--range',
                        metavar = '[PATCH1][:[PATCH2]]',
                        help = 'export patches between PATCH1 and PATCH2'),
            make_option('-b', '--branch',
-                       help = 'use BRANCH instead of the default one')]
+                       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):
@@ -73,11 +81,13 @@ def func(parser, options, args):
         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(':')
@@ -99,11 +109,18 @@ def func(parser, options, args):
         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'
@@ -114,6 +131,9 @@ def func(parser, options, args):
     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
@@ -124,7 +144,7 @@ def func(parser, options, args):
     else:
         patch_tmpl_list = []
 
-    patch_tmpl_list += [os.path.join(git.base_dir, 'patchexport.tmpl'),
+    patch_tmpl_list += [os.path.join(git.get_base_dir(), 'patchexport.tmpl'),
                         os.path.join(sys.prefix,
                                      'share/stgit/templates/patchexport.tmpl')]
     tmpl = ''
@@ -133,22 +153,39 @@ def func(parser, options, args):
             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.diff:
             pname = '%s.diff' % pname
+        elif options.patch:
+            pname = '%s.patch' % pname
         if options.numbered:
             pname = '%s-%s' % (str(patch_no).zfill(zpadding), pname)
         pfile = os.path.join(dirname, pname)
-        print >> series, pname
+        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(),
@@ -166,14 +203,26 @@ def func(parser, options, args):
         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()