diff --git a/hgext/purge.py b/hgext/purge.py --- a/hgext/purge.py +++ b/hgext/purge.py @@ -32,28 +32,26 @@ from mercurial.i18n import _ import os def purge(ui, repo, *dirs, **opts): - '''removes files not tracked by mercurial + '''removes files not tracked by Mercurial - Delete files not known to mercurial, this is useful to test local and - uncommitted changes in the otherwise clean source tree. + Delete files not known to Mercurial. This is useful to test local and + uncommitted changes in an otherwise-clean source tree. This means that purge will delete: - Unknown files: files marked with "?" by "hg status" - - Ignored files: files usually ignored by Mercurial because they match - a pattern in a ".hgignore" file - Empty directories: in fact Mercurial ignores directories unless they contain files under source control managment But it will leave untouched: - - Unmodified tracked files - - Modified tracked files + - Modified and unmodified tracked files + - Ignored files (unless --all is specified) - New files added to the repository (with "hg add") If directories are given on the command line, only files in these directories are considered. - Be careful with purge, you could irreversibly delete some files you + Be careful with purge, as you could irreversibly delete some files you forgot to add to the repository. If you only want to print the list of - files that this program would delete use the --print option. + files that this program would delete, use the --print option. ''' act = not opts['print'] eol = '\n'