##// END OF EJS Templates
purge: wrap docstrings at 70 characters
Martin Geisler -
r9270:00cc7fa0 default
parent child Browse files
Show More
@@ -1,110 +1,111 b''
1 # Copyright (C) 2006 - Marco Barisione <marco@barisione.org>
1 # Copyright (C) 2006 - Marco Barisione <marco@barisione.org>
2 #
2 #
3 # This is a small extension for Mercurial (http://mercurial.selenic.com/)
3 # This is a small extension for Mercurial (http://mercurial.selenic.com/)
4 # that removes files not known to mercurial
4 # that removes files not known to mercurial
5 #
5 #
6 # This program was inspired by the "cvspurge" script contained in CVS utilities
6 # This program was inspired by the "cvspurge" script contained in CVS
7 # (http://www.red-bean.com/cvsutils/).
7 # utilities (http://www.red-bean.com/cvsutils/).
8 #
8 #
9 # For help on the usage of "hg purge" use:
9 # For help on the usage of "hg purge" use:
10 # hg help purge
10 # hg help purge
11 #
11 #
12 # This program is free software; you can redistribute it and/or modify
12 # This program is free software; you can redistribute it and/or modify
13 # it under the terms of the GNU General Public License as published by
13 # it under the terms of the GNU General Public License as published by
14 # the Free Software Foundation; either version 2 of the License, or
14 # the Free Software Foundation; either version 2 of the License, or
15 # (at your option) any later version.
15 # (at your option) any later version.
16 #
16 #
17 # This program is distributed in the hope that it will be useful,
17 # This program is distributed in the hope that it will be useful,
18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 # GNU General Public License for more details.
20 # GNU General Public License for more details.
21 #
21 #
22 # You should have received a copy of the GNU General Public License
22 # You should have received a copy of the GNU General Public License
23 # along with this program; if not, write to the Free Software
23 # along with this program; if not, write to the Free Software
24 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25
25
26 '''command to delete untracked files from the working directory'''
26 '''command to delete untracked files from the working directory'''
27
27
28 from mercurial import util, commands, cmdutil
28 from mercurial import util, commands, cmdutil
29 from mercurial.i18n import _
29 from mercurial.i18n import _
30 import os, stat
30 import os, stat
31
31
32 def purge(ui, repo, *dirs, **opts):
32 def purge(ui, repo, *dirs, **opts):
33 '''removes files not tracked by Mercurial
33 '''removes files not tracked by Mercurial
34
34
35 Delete files not known to Mercurial. This is useful to test local and
35 Delete files not known to Mercurial. This is useful to test local
36 uncommitted changes in an otherwise-clean source tree.
36 and uncommitted changes in an otherwise-clean source tree.
37
37
38 This means that purge will delete:
38 This means that purge will delete:
39
39
40 - Unknown files: files marked with "?" by "hg status"
40 - Unknown files: files marked with "?" by "hg status"
41 - Empty directories: in fact Mercurial ignores directories unless they
41 - Empty directories: in fact Mercurial ignores directories unless
42 contain files under source control management
42 they contain files under source control management
43
43
44 But it will leave untouched:
44 But it will leave untouched:
45
45
46 - Modified and unmodified tracked files
46 - Modified and unmodified tracked files
47 - Ignored files (unless --all is specified)
47 - Ignored files (unless --all is specified)
48 - New files added to the repository (with "hg add")
48 - New files added to the repository (with "hg add")
49
49
50 If directories are given on the command line, only files in these
50 If directories are given on the command line, only files in these
51 directories are considered.
51 directories are considered.
52
52
53 Be careful with purge, as you could irreversibly delete some files you
53 Be careful with purge, as you could irreversibly delete some files
54 forgot to add to the repository. If you only want to print the list of
54 you forgot to add to the repository. If you only want to print the
55 files that this program would delete, use the --print option.
55 list of files that this program would delete, use the --print
56 option.
56 '''
57 '''
57 act = not opts['print']
58 act = not opts['print']
58 eol = '\n'
59 eol = '\n'
59 if opts['print0']:
60 if opts['print0']:
60 eol = '\0'
61 eol = '\0'
61 act = False # --print0 implies --print
62 act = False # --print0 implies --print
62
63
63 def remove(remove_func, name):
64 def remove(remove_func, name):
64 if act:
65 if act:
65 try:
66 try:
66 remove_func(repo.wjoin(name))
67 remove_func(repo.wjoin(name))
67 except OSError:
68 except OSError:
68 m = _('%s cannot be removed') % name
69 m = _('%s cannot be removed') % name
69 if opts['abort_on_err']:
70 if opts['abort_on_err']:
70 raise util.Abort(m)
71 raise util.Abort(m)
71 ui.warn(_('warning: %s\n') % m)
72 ui.warn(_('warning: %s\n') % m)
72 else:
73 else:
73 ui.write('%s%s' % (name, eol))
74 ui.write('%s%s' % (name, eol))
74
75
75 def removefile(path):
76 def removefile(path):
76 try:
77 try:
77 os.remove(path)
78 os.remove(path)
78 except OSError:
79 except OSError:
79 # read-only files cannot be unlinked under Windows
80 # read-only files cannot be unlinked under Windows
80 s = os.stat(path)
81 s = os.stat(path)
81 if (s.st_mode & stat.S_IWRITE) != 0:
82 if (s.st_mode & stat.S_IWRITE) != 0:
82 raise
83 raise
83 os.chmod(path, stat.S_IMODE(s.st_mode) | stat.S_IWRITE)
84 os.chmod(path, stat.S_IMODE(s.st_mode) | stat.S_IWRITE)
84 os.remove(path)
85 os.remove(path)
85
86
86 directories = []
87 directories = []
87 match = cmdutil.match(repo, dirs, opts)
88 match = cmdutil.match(repo, dirs, opts)
88 match.dir = directories.append
89 match.dir = directories.append
89 status = repo.status(match=match, ignored=opts['all'], unknown=True)
90 status = repo.status(match=match, ignored=opts['all'], unknown=True)
90
91
91 for f in sorted(status[4] + status[5]):
92 for f in sorted(status[4] + status[5]):
92 ui.note(_('Removing file %s\n') % f)
93 ui.note(_('Removing file %s\n') % f)
93 remove(removefile, f)
94 remove(removefile, f)
94
95
95 for f in sorted(directories, reverse=True):
96 for f in sorted(directories, reverse=True):
96 if match(f) and not os.listdir(repo.wjoin(f)):
97 if match(f) and not os.listdir(repo.wjoin(f)):
97 ui.note(_('Removing directory %s\n') % f)
98 ui.note(_('Removing directory %s\n') % f)
98 remove(os.rmdir, f)
99 remove(os.rmdir, f)
99
100
100 cmdtable = {
101 cmdtable = {
101 'purge|clean':
102 'purge|clean':
102 (purge,
103 (purge,
103 [('a', 'abort-on-err', None, _('abort if an error occurs')),
104 [('a', 'abort-on-err', None, _('abort if an error occurs')),
104 ('', 'all', None, _('purge ignored files too')),
105 ('', 'all', None, _('purge ignored files too')),
105 ('p', 'print', None, _('print filenames instead of deleting them')),
106 ('p', 'print', None, _('print filenames instead of deleting them')),
106 ('0', 'print0', None, _('end filenames with NUL, for use with xargs'
107 ('0', 'print0', None, _('end filenames with NUL, for use with xargs'
107 ' (implies -p/--print)')),
108 ' (implies -p/--print)')),
108 ] + commands.walkopts,
109 ] + commands.walkopts,
109 _('hg purge [OPTION]... [DIR]...'))
110 _('hg purge [OPTION]... [DIR]...'))
110 }
111 }
General Comments 0
You need to be logged in to leave comments. Login now