Auto-generate man pages for all StGit commands
[stgit] / stgit / commands / files.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 stgit.argparse import opt
21 from stgit.commands.common import *
22 from stgit.utils import *
23 from stgit.out import *
24 from stgit import argparse, stack, git
25
26 help = 'Show the files modified by a patch (or the current patch)'
27 usage = ['[options] [[<branch>:]<patch>]']
28 description = """
29 List the files modified by the given patch (defaulting to the current
30 one). Passing the '--stat' option shows the diff statistics for the
31 given patch. Note that this command doesn't show the files modified in
32 the working tree and not yet included in the patch by a 'refresh'
33 command. Use the 'diff' or 'status' commands for these files."""
34
35 options = [
36 opt('-s', '--stat', action = 'store_true',
37 short = 'Show the diffstat'),
38 opt('--bare', action = 'store_true',
39 short = 'Bare file names (useful for scripting)'),
40 ] + argparse.diff_opts_option()
41
42 directory = DirectoryHasRepository()
43
44 def func(parser, options, args):
45 """Show the files modified by a patch (or the current patch)
46 """
47 if len(args) == 0:
48 patch = 'HEAD'
49 elif len(args) == 1:
50 patch = args[0]
51 else:
52 parser.error('incorrect number of arguments')
53
54 rev1 = git_id(crt_series, '%s^' % patch)
55 rev2 = git_id(crt_series, '%s' % patch)
56
57 if options.stat:
58 out.stdout_raw(git.diffstat(git.diff(rev1 = rev1, rev2 = rev2)) + '\n')
59 elif options.bare:
60 out.stdout_raw(git.barefiles(rev1, rev2) + '\n')
61 else:
62 out.stdout_raw(git.files(rev1, rev2, diff_flags = options.diff_flags)
63 + '\n')