Rewritten install instructions for hg-purge to match new situation, fixed typos.
authorThomas Arendsen Hein <thomas@intevation.de>
Fri, 02 Jun 2006 00:28:28 +0200
changeset 2381 ab7a438294fc
parent 2380 46ec76f80e18
child 2382 b429566d1994
Rewritten install instructions for hg-purge to match new situation, fixed typos.
hgext/purge/README
hgext/purge/__init__.py
--- a/hgext/purge/README	Thu Jun 01 23:58:43 2006 +0200
+++ b/hgext/purge/README	Fri Jun 02 00:28:28 2006 +0200
@@ -20,7 +20,7 @@
 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
+  hg purge --print
 
 To get the most recent version of "hg purge" visit its home page:
   http://www.barisione.org/apps.html#hg-purge
@@ -31,20 +31,11 @@
 
 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.
+The purge extension is distributed with Mercurial, to activate it you need to
+put these lines in your ~/.hgrc:
 
-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.
+  hgext.purge=
 
 For more information on the configuration files see the man page for "hgrc":
   man 5 hgrc
@@ -66,4 +57,4 @@
 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.
+with Mercurial in the file COPYING.
--- a/hgext/purge/__init__.py	Thu Jun 01 23:58:43 2006 +0200
+++ b/hgext/purge/__init__.py	Fri Jun 02 00:28:28 2006 +0200
@@ -104,7 +104,7 @@
 
     def _split_path(self, path):
         '''
-        Retruns a list of the single files/directories in "path".
+        Returns a list of the single files/directories in "path".
         For instance:
           '/home/user/test' -> ['/', 'home', 'user', 'test']
           'C:\\Mercurial'   -> ['C:\\', 'Mercurial']
@@ -144,7 +144,7 @@
      - 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
+     - Empty directories: in fact Mercurial ignores directories unless they
        contain files under source control managment
     But it will leave untouched:
      - Unmodified tracked files
@@ -156,7 +156,7 @@
 
     Be careful with 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 the -vn options.
+    files that this program would delete use the --print option.
     '''
     act = not opts['print']
     abort_on_err = bool(opts['abort_on_err'])