README
changeset 2364 f368a1c302d5
child 2365 a5d2e5490ac7
equal deleted inserted replaced
-1:000000000000 2364:f368a1c302d5
       
     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 -vn
       
    24 
       
    25 
       
    26 How to install
       
    27 ==============
       
    28 Put the "purge.py" file in a directory of your choice, then enable the
       
    29 extension putting a line like:
       
    30   purge=/path/you/choose/purge.py
       
    31 in the "[extensions]" section of a configuration file read by "hg". For
       
    32 more information on these files read the man page for "hgrc":
       
    33   man 5 hgrc
       
    34 
       
    35 
       
    36 How to use "hg purge"
       
    37 ====================
       
    38 For help on the usage of "hg purge" use:
       
    39   hg help purge
       
    40 
       
    41 
       
    42 License
       
    43 =======
       
    44 Copyright (C) 2006 - Marco Barisione <marco@barisione.org>
       
    45 
       
    46 This program is distributed in the hope that it will be useful,
       
    47 but WITHOUT ANY WARRANTY; without even the implied warranty of
       
    48 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       
    49 GNU General Public License for more details.
       
    50 
       
    51 A copy of the GNU General Public License is distributed along
       
    52 with this program in the file COPYING.GPL.