3 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
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.
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.
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
20 from optparse
import OptionParser
, make_option
22 import stgit
.commands
.common
23 from stgit
.commands
.common
import *
24 from stgit
.utils
import *
25 from stgit
import stack
, git
28 help = 'print the patch series'
29 usage
= """%prog [options] [<patch-range>]
31 Show all the patches in the series or just those in the given
32 range. The applied patches are prefixed with a '+' and the unapplied
33 ones with a '-'. The current patch is prefixed with a '>'. Empty
34 patches are prefixed with a '0'. The '*' postfix is appended to hidden
37 options
= [make_option('-b', '--branch',
38 help = 'use BRANCH instead of the default one'),
39 make_option('-a', '--all',
40 help = 'show all patches, including the hidden ones',
41 action
= 'store_true'),
42 make_option('-i', '--invisible',
43 help = 'show the hidden patches only',
44 action
= 'store_true'),
45 make_option('-m', '--missing', metavar
= 'BRANCH',
46 help = 'show patches in BRANCH missing in current'),
47 make_option('-c', '--count',
48 help = 'print the number of patches in the series',
49 action
= 'store_true'),
50 make_option('-d', '--description',
51 help = 'show a short description for each patch',
52 action
= 'store_true'),
53 make_option('--author',
54 help = 'show the author name for each patch',
55 action
= 'store_true'),
56 make_option('-e', '--empty',
57 help = 'check whether patches are empty '
59 action
= 'store_true'),
60 make_option('--showbranch',
61 help = 'append the branch name to the listed patches',
62 action
= 'store_true'),
63 make_option('--noprefix',
64 help = 'do not show the patch status prefix',
65 action
= 'store_true'),
66 make_option('-s', '--short',
67 help = 'list just the patches around the topmost patch',
68 action
= 'store_true'),
69 make_option('-g', '--graphical',
70 help = 'run gitk instead of printing',
71 action
= 'store_true')]
74 def __get_description(patch
):
75 """Extract and return a patch's short description
77 p
= crt_series
.get_patch(patch
)
78 descr
= (p
.get_description() or '').strip()
79 descr_lines
= descr
.split('\n')
80 return descr_lines
[0].rstrip()
82 def __get_author(patch
):
83 """Extract and return a patch's short description
85 p
= crt_series
.get_patch(patch
)
86 return p
.get_authname();
88 def __print_patch(patch
, hidden
, branch_str
, prefix
, empty_prefix
, length
,
90 """Print a patch name, description and various markers.
94 elif options
.empty
and crt_series
.empty_patch(patch
):
97 patch_str
= patch
+ branch_str
98 if not options
.noprefix
and patch
in hidden
:
101 if options
.description
or options
.author
:
102 patch_str
= patch_str
.ljust(length
)
104 if options
.description
:
105 print prefix
+ patch_str
+ ' | ' + __get_description(patch
)
107 print prefix
+ patch_str
+ ' | ' + __get_author(patch
)
109 print prefix
+ patch_str
111 def func(parser
, options
, args
):
112 """Show the patch series
117 # switch the series, the one specified with --missing should
119 cmp_series
= crt_series
120 crt_series
= stack
.Series(options
.missing
)
121 stgit
.commands
.common
.crt_series
= crt_series
123 cmp_patches
= cmp_series
.get_applied() + cmp_series
.get_unapplied()
127 applied
= crt_series
.get_applied()
128 unapplied
= crt_series
.get_unapplied()
130 # the filtering range covers the whole series
132 show_patches
= parse_patches(args
, applied
+ unapplied
, len(applied
))
134 show_patches
= applied
+ unapplied
137 show_patches
= [p
for p
in show_patches
if p
not in cmp_patches
]
139 # hidden patches filtering
140 hidden
= crt_series
.get_hidden()
141 if options
.invisible
:
142 show_patches
= [p
for p
in show_patches
if p
in hidden
]
143 elif not options
.all
:
144 show_patches
= [p
for p
in show_patches
if p
not in hidden
]
147 applied
= [p
for p
in applied
if p
in show_patches
]
148 unapplied
= [p
for p
in unapplied
if p
in show_patches
]
151 nr
= int(config
.get('stgit.shortnr'))
152 if len(applied
) > nr
:
153 applied
= applied
[-(nr
+1):]
154 if len(unapplied
) > nr
:
155 unapplied
= unapplied
[:nr
]
157 patches
= applied
+ unapplied
166 if options
.showbranch
:
167 branch_str
= '@' + crt_series
.get_branch()
171 if options
.graphical
:
173 raise CmdException
, '--graphical not supported with --missing'
176 gitk_args
= ' %s^..%s' %
(git_id(applied
[0]), git_id(applied
[-1]))
182 gitk_args
+= ' %s^..%s' %
(patch_id
, patch_id
)
184 if os
.system('gitk%s' % gitk_args
) != 0:
185 raise CmdException
, 'gitk execution failed'
189 max_len
= max([len(i
+ branch_str
) for i
in patches
])
193 current
= crt_series
.get_current()
194 if applied
[-1] == current
:
200 __print_patch(p
, hidden
, branch_str
, '+ ', '0 ', max_len
,
204 __print_patch(current
, hidden
, branch_str
, '> ', '0>', max_len
,
208 __print_patch(p
, hidden
, branch_str
, '- ', '0 ', max_len
, options
)