|
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 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 Obviously you need an installed version of Mercurial to use this extension. |
|
35 "purge" has been tested with Mercurial 0.8.1 and 0.9 but it may work with |
|
36 other versions as well. |
|
37 |
|
38 Put the "purge.py" file in a directory of your choice. Enable the extension |
|
39 inserting an instruction like "purge=/path/you/choose/purge.py" in the |
|
40 "[extensions]" section of a configuration file read by "hg". |
|
41 |
|
42 For instance if you installed the script in "/home/USER/hg-purge/", you |
|
43 can create a file named ".hgrc" in your home directory with the following |
|
44 content: |
|
45 [extensions] |
|
46 purge=/home/USER/hg-purge/purge.py |
|
47 Note that using "~/USER/hg-purge/purge.py" does not work with hg 0.9. |
|
48 |
|
49 For more information on the configuration files see the man page for "hgrc": |
|
50 man 5 hgrc |
|
51 |
|
52 |
|
53 How to use "hg purge" |
|
54 ==================== |
|
55 For help on the usage of "hg purge" use: |
|
56 hg help purge |
|
57 |
|
58 |
|
59 License |
|
60 ======= |
|
61 Copyright (C) 2006 - Marco Barisione <marco@barisione.org> |
|
62 |
|
63 This program is distributed in the hope that it will be useful, |
|
64 but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
65 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
66 GNU General Public License for more details. |
|
67 |
|
68 A copy of the GNU General Public License is distributed along |
|
69 with this program in the file COPYING.GPL. |