"stg series" option to show patch summary descriptions
[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 show 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
44
45 def __get_description(patch):
46 """Extract and return a patch's short description
47 """
48 p = crt_series.get_patch(patch)
49 descr = p.get_description().strip()
50 descr_lines = descr.split('\n')
51 return descr_lines[0].rstrip()
52
53 def __print_patch(patch, prefix, empty_prefix, length, options):
54 if options.empty and crt_series.empty_patch(patch):
55 prefix = empty_prefix
56 if options.description:
57 print prefix + patch.ljust(length) + ' | ' + __get_description(patch)
58 else:
59 print prefix + patch
60
61 def func(parser, options, args):
62 """Show the patch series
63 """
64 if len(args) != 0:
65 parser.error('incorrect number of arguments')
66
67 applied = crt_series.get_applied()
68 unapplied = crt_series.get_unapplied()
69 patches = applied + unapplied
70
71 max_len = 0
72 if len(patches) > 0:
73 max_len = max([len(i) for i in patches])
74
75 if len(applied) > 0:
76 for p in applied [0:-1]:
77 __print_patch(p, '+ ', '0 ', max_len, options)
78
79 __print_patch(applied[-1], '> ', '0>', max_len, options)
80
81 for p in unapplied:
82 __print_patch(p, '- ', '0 ', max_len, options)