hgext/purge/README
changeset 2401 dbeaa4369121
parent 2400 2e90024e1471
child 2402 82cef38fea56
equal deleted inserted replaced
2400:2e90024e1471 2401:dbeaa4369121
     1 What is "hg purge"?
       
     2 ===================
       
     3 "purge" is a simple extension for the Mercurial source control management
       
     4 system (http://www.selenic.com/mercurial).
       
     5 This extension adds a "purge" command to "hg" that removes files not known
       
     6 to Mercurial, this is useful to test local and uncommitted changes in the
       
     7 otherwise clean source tree.
       
     8 
       
     9 This means that Mercurial will delete:
       
    10  - Unknown files: files marked with "?" by "hg status"
       
    11  - Ignored files: files usually ignored by Mercurial because they match a
       
    12    pattern in a ".hgignore" file
       
    13  - Empty directories: infact Mercurial ignores directories unless they
       
    14    contain files under source control managment
       
    15 But it will leave untouched:
       
    16  - Unmodified files tracked by Mercurial
       
    17  - Modified files tracked by Mercurial
       
    18  - New files added to the repository (with "hg add")
       
    19 
       
    20 Be careful with "hg purge", you could irreversibly delete some files you
       
    21 forgot to add to the repository. If you only want to print the list of
       
    22 files that this program would delete use:
       
    23   hg purge --print
       
    24 
       
    25 To get the most recent version of "hg purge" visit its home page:
       
    26   http://www.barisione.org/apps.html#hg-purge
       
    27 
       
    28 This program was inspired by the "cvspurge" script contained in CVS utilities
       
    29 (http://www.red-bean.com/cvsutils/).
       
    30 
       
    31 
       
    32 How to install
       
    33 ==============
       
    34 The purge extension is distributed with Mercurial, to activate it you need to
       
    35 put these lines in your ~/.hgrc:
       
    36 
       
    37   [extensions]
       
    38   hgext.purge=
       
    39 
       
    40 For more information on the configuration files see the man page for "hgrc":
       
    41   man 5 hgrc
       
    42 
       
    43 
       
    44 How to use "hg purge"
       
    45 ====================
       
    46 For help on the usage of "hg purge" use:
       
    47   hg help purge
       
    48 
       
    49 
       
    50 License
       
    51 =======
       
    52 Copyright (C) 2006 - Marco Barisione <marco@barisione.org>
       
    53 
       
    54 This program is distributed in the hope that it will be useful,
       
    55 but WITHOUT ANY WARRANTY; without even the implied warranty of
       
    56 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       
    57 GNU General Public License for more details.
       
    58 
       
    59 A copy of the GNU General Public License is distributed along
       
    60 with Mercurial in the file COPYING.