changeset 631:a287f6cd9c6b

Update documentation of hg tag
# HG changeset patch
# User Radoslaw Szkodzinski <[e-mail]>
# Node ID 8fc9bfabae06cba91b05c265545bcce2654dab2f
# Parent  7369ec5d93f2ffd490a43970edd9adf8d2bbe269
Update documentation of hg tag

This updates the FAQ, manpage and adds hg tag to the list of commands
in README.

Index: hg/README
===================================================================

--- a/README	Tue Jul 05 18:22:28 2005 -0800
+++ b/README	Tue Jul 05 18:23:34 2005 -0800
@@ -55,6 +55,8 @@
  $ hg remove bar       # mark a file as removed
  $ hg verify           # check repo integrity
  $ hg tags             # show current tags
+ $ hg tag <name>       # tag current tip with distributed tag <name>
+ $ hg tag -l <name>    # tag current tip with local tag <name>
  $ hg annotate [files] # show changeset numbers for each file line
 
 Branching and merging:

--- a/doc/FAQ.txt	Tue Jul 05 18:22:28 2005 -0800
+++ b/doc/FAQ.txt	Tue Jul 05 18:23:34 2005 -0800
@@ -124,10 +124,10 @@
 
 .Q. What if I want to just keep local tags?
 
-You can add a section called "[tags]" to your .hg/hgrc which contains
-a list of tag = changeset ID pairs. Unlike traditional tags, these are
-only visible in the local repository, but otherwise act just like
-normal tags.
+You can use "hg tag" command with an option "-l" or "--local". This
+will store the tag in the file .hg/localtags, which will not be
+distributed or versioned. The format of this file is identical to the
+one of .hgtags and the tags stored there are handled the same.
 
 
 .Q. How do tags work with multiple heads?

--- a/doc/hg.1.txt	Tue Jul 05 18:22:28 2005 -0800
+++ b/doc/hg.1.txt	Tue Jul 05 18:23:34 2005 -0800
@@ -329,7 +329,7 @@
     R = removed
     ? = not tracked
 
-tag [-t <text> -d <datecode> -u <user>] <name> [revision]::
+tag [-l -t <text> -d <datecode> -u <user>] <name> [revision]::
     Name a particular revision using <name>.
     
     Tags are used to name particular revisions of the repository and are
@@ -344,13 +344,14 @@
     necessary.
 
     options:
+    -l, --local           make the tag local
     -t, --text <text>     message for tag commit log entry
     -d, --date <datecode> datecode for commit
     -u, --user <user>     user for commit
 
-    Note: Mercurial also has support for "local tags" that are not
-    version-controlled or distributed which are stored in the .hg/hgrc
-    file.
+    Note: Local tags are not version-controlled or distributed and are
+    stored in the .hg/localtags file. If there exists a local tag and
+    a public tag with the same name, local tag is used.
 
 tags::
     List the repository tags.