e66f1bd1d6432e1784db1c37c164eefe8e627dfd
[stgit] / stgit / commands / series.py
1
2 __copyright__ = """
3 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License version 2 as
7 published by the Free Software Foundation.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 """
18
19 import sys, os
20 from optparse import OptionParser, make_option
21
22 from stgit.commands.common import *
23 from stgit.utils import *
24 from stgit import stack, git
25
26
27 help = 'print the patch series'
28 usage = """%prog [options]
29
30 Show all the patches in the series. The applied patches are prefixed
31 with a '+' and the unapplied ones with a '-'. The current patch is
32 prefixed with a '>'. Empty patches are prefixed with a '0'."""
33
34 options = [make_option('-b', '--branch',
35 help = 'use BRANCH instead of the default one'),
36 make_option('-d', '--description',
37 help = 'show a short description for each patch',
38 action = 'store_true'),
39 make_option('-e', '--empty',
40 help = 'check whether patches are empty '
41 '(much slower)',
42 action = 'store_true'),
43 make_option('-s', '--short',
44 help = 'list just the patches around the topmost patch',
45 action = 'store_true'),
46 make_option('-g', '--graphical',
47 help = 'run gitk instead of printing',
48 action = 'store_true')]
49
50
51 def __get_description(patch):
52 """Extract and return a patch's short description
53 """
54 p = crt_series.get_patch(patch)
55 descr = p.get_description().strip()
56 descr_lines = descr.split('\n')
57 return descr_lines[0].rstrip()
58
59 def __print_patch(patch, prefix, empty_prefix, length, options):
60 if options.empty and crt_series.empty_patch(patch):
61 prefix = empty_prefix
62 if options.description:
63 print prefix + patch.ljust(length) + ' | ' + __get_description(patch)
64 else:
65 print prefix + patch
66
67 def func(parser, options, args):
68 """Show the patch series
69 """
70 if len(args) != 0:
71 parser.error('incorrect number of arguments')
72
73 applied = crt_series.get_applied()
74 unapplied = crt_series.get_unapplied()
75
76 if options.short:
77 if len(applied) > 5:
78 applied = applied[-6:]
79 if len(unapplied) > 5:
80 unapplied = unapplied[:5]
81
82 patches = applied + unapplied
83 if not patches:
84 return
85
86 if options.graphical:
87 if applied:
88 gitk_args = ' %s^..%s' % (git_id(applied[0]), git_id(applied[-1]))
89 else:
90 gitk_args = ''
91
92 for p in unapplied:
93 patch_id = git_id(p)
94 gitk_args += ' %s^..%s' % (patch_id, patch_id)
95
96 if os.system('gitk%s' % gitk_args) != 0:
97 raise CmdException, 'gitk execution failed'
98 else:
99 max_len = 0
100 if len(patches) > 0:
101 max_len = max([len(i) for i in patches])
102
103 if len(applied) > 0:
104 for p in applied [0:-1]:
105 __print_patch(p, '+ ', '0 ', max_len, options)
106
107 __print_patch(applied[-1], '> ', '0>', max_len, options)
108
109 for p in unapplied:
110 __print_patch(p, '- ', '0 ', max_len, options)