aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README26
1 files changed, 23 insertions, 3 deletions
diff --git a/README b/README
index 193b106..c63a0de 100644
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
This is a simple Mercurial extension which adds an "eggtag" command.
When you want to make a new release, just type
- hg eggtag 0.1
+ hg eggtag 0.1
The command will automatically tag and add an entry to your egg's
release-info file corresponding to this release.
@@ -10,5 +10,25 @@ You only need the python file (can be downloaded using the source code
browser, and then viewing the "raw" source). Just drop it in your ~/.hg
directory and add the following to your .hgrc:
-[extensions]
-egg-author=~/.hg/egg-author.py
+ [extensions]
+ egg-author=~/.hg/egg-author.py
+
+By default, eggtag will also update the .meta-file of your egg.
+If you don't like this behaviour, you can turn it off by adding
+the following to your .hgrc:
+
+ [egg-author]
+ update-meta=False
+
+This can also be overridden on a per-repository basis by adding the
+section to your repository's .hg/hgrc file. The value can obviously
+also be True if you want to override the False value from your ~/.hgrc.
+
+
+If you want to run the meta-file updater manually (regardless of the
+update-meta option), you can run the update-meta command:
+
+ hg update-meta
+
+This will only update the file, but not commit it so that you can
+review it before committing it. \ No newline at end of file