diff hgext/purge/README @ 2379:e90cff87f871

Reorganized files in hg-purge repo to push them into Mercurial.
README -> hgext/purge/README
purge.py -> hgext/purge/__init__.py
removed COPYING.GPL and .hgignore (already in the Mercurial repo)

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/hgext/purge/README	Thu Jun 01 23:58:06 2006 +0200
@@ -0,0 +1,69 @@
+What is "hg purge"?
+===================
+"purge" is a simple extension for the Mercurial source control management
+system (http://www.selenic.com/mercurial).
+This extension adds a "purge" command to "hg" that removes files not known
+to Mercurial, this is useful to test local and uncommitted changes in the
+otherwise clean source tree.
+
+This means that Mercurial 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: infact Mercurial ignores directories unless they
+   contain files under source control managment
+But it will leave untouched:
+ - Unmodified files tracked by Mercurial
+ - Modified files tracked by Mercurial
+ - New files added to the repository (with "hg add")
+
+Be careful with "hg purge", 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:
+  hg purge -vn
+
+To get the most recent version of "hg purge" visit its home page:
+  http://www.barisione.org/apps.html#hg-purge
+
+This program was inspired by the "cvspurge" script contained in CVS utilities
+(http://www.red-bean.com/cvsutils/).
+
+
+How to install
+==============
+Obviously you need an installed version of Mercurial to use this extension.
+"purge" has been tested with Mercurial 0.8.1 and 0.9 but it may work with
+other versions as well.
+
+Put the "purge.py" file in a directory of your choice. Enable the extension
+inserting an instruction like "purge=/path/you/choose/purge.py" in the
+"[extensions]" section of a configuration file read by "hg".
+
+For instance if you installed the script in "/home/USER/hg-purge/", you
+can create a file named  ".hgrc" in your home directory with the following
+content:
+  [extensions]
+  purge=/home/USER/hg-purge/purge.py
+Note that using "~/USER/hg-purge/purge.py" does not work with hg 0.9.
+
+For more information on the configuration files see the man page for "hgrc":
+  man 5 hgrc
+
+
+How to use "hg purge"
+====================
+For help on the usage of "hg purge" use:
+  hg help purge
+
+
+License
+=======
+Copyright (C) 2006 - Marco Barisione <[e-mail]>
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+A copy of the GNU General Public License is distributed along
+with this program in the file COPYING.GPL.