annotate README @ 2364:f368a1c302d5

Initial commit
author demian@gaudron.lan
date Fri, 12 May 2006 20:26:19 +0200
parents
children a5d2e5490ac7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2364
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
1 What is "hg purge"?
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
2 ===================
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
3 "purge" is a simple extension for the Mercurial source control management
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
4 system (http://www.selenic.com/mercurial).
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
5 This extension adds a "purge" command to "hg" that removes files not known
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
6 to mercurial, this is useful to test local and uncommitted changes in the
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
7 otherwise clean source tree.
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
8
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
9 This means that Mercurial will delete:
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
10 - Unknown files: files marked with "?" by "hg status"
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
11 - Ignored files: files usually ignored by Mercurial because they match a
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
12 pattern in a ".hgignore" file
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
13 - Empty directories: infact Mercurial ignores directories unless they
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
14 contain files under source control managment
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
15 But it will leave untouched:
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
16 - Unmodified files tracked by Mercurial
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
17 - Modified files tracked by Mercurial
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
18 - New files added to the repository (with "hg add")
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
19
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
20 Be careful with "hg purge", you could irreversibly delete some files you
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
21 forgot to add to the repository. If you only want to print the list of
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
22 files that this program would delete use:
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
23 hg purge -vn
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
24
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
25
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
26 How to install
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
27 ==============
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
28 Put the "purge.py" file in a directory of your choice, then enable the
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
29 extension putting a line like:
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
30 purge=/path/you/choose/purge.py
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
31 in the "[extensions]" section of a configuration file read by "hg". For
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
32 more information on these files read the man page for "hgrc":
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
33 man 5 hgrc
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
34
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
35
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
36 How to use "hg purge"
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
37 ====================
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
38 For help on the usage of "hg purge" use:
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
39 hg help purge
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
40
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
41
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
42 License
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
43 =======
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
44 Copyright (C) 2006 - Marco Barisione <marco@barisione.org>
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
45
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
46 This program is distributed in the hope that it will be useful,
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
47 but WITHOUT ANY WARRANTY; without even the implied warranty of
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
48 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
49 GNU General Public License for more details.
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
50
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
51 A copy of the GNU General Public License is distributed along
f368a1c302d5 Initial commit
demian@gaudron.lan
parents:
diff changeset
52 with this program in the file COPYING.GPL.