Documentation: be consistent about "git-" versus "git "

[thirdparty/git.git] / Documentation / git-tag.txt
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt

index b62a3d1c5896a3b2e32af58029115240d609f37b..95531349a29486964071d2e761b188ffad87f8d2 100644 (file)
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -9,10 +9,10 @@ git-tag - Create, list, delete or verify a tag object signed with GPG
  SYNOPSIS
  --------
  [verse]
-'git-tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]  <name> [<head>]
-'git-tag' -d <name>...
-'git-tag' [-n [<num>]] -l [<pattern>]
-'git-tag' -v <name>...
+'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]  <name> [<head>]
+'git tag' -d <name>...
+'git tag' [-n[<num>]] -l [<pattern>]
+'git tag' -v <name>...
  
  DESCRIPTION
  -----------
@@ -26,6 +26,9 @@ creates a 'tag' object, and requires the tag message.  Unless
  `-m <msg>` or `-F <file>` is given, an editor is started for the user to type
  in the tag message.
  
+If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>`
+are absent, `-a` is implied.
+
  Otherwise just the SHA1 object name of the commit object is
  written (i.e. a lightweight tag).
  
@@ -54,7 +57,7 @@ OPTIONS
  -v::
         Verify the gpg signature of the given tag names.
  
--n <num>::
+-n<num>::
         <num> specifies how many lines from the annotation, if any,
         are printed when using -l.
         The default is not to print any annotation lines.
@@ -68,10 +71,14 @@ OPTIONS
         Use the given tag message (instead of prompting).
         If multiple `-m` options are given, there values are
         concatenated as separate paragraphs.
+       Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
+       is given.
  
  -F <file>::
         Take the tag message from the given file.  Use '-' to
         read the message from the standard input.
+       Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
+       is given.
  
  CONFIGURATION
  -------------
@@ -111,12 +118,12 @@ and be done with it.
  
  . The insane thing.
  You really want to call the new version "X" too, 'even though'
-others have already seen the old one. So just use "git tag -f"
+others have already seen the old one. So just use "git-tag -f"
  again, as if you hadn't already published the old one.
  
  However, Git does *not* (and it should not) change tags behind
-users back. So if somebody already got the old tag, doing a "git
-pull" on your tree shouldn't just make them overwrite the old
+users back. So if somebody already got the old tag, doing a
+"git-pull" on your tree shouldn't just make them overwrite the old
  one.
  
  If somebody got a release tag from you, you cannot just change
@@ -170,7 +177,7 @@ private anchor point tags from the other person.
  
  You would notice "please pull" messages on the mailing list says
  repo URL and branch name alone.  This is designed to be easily
-cut&pasted to "git fetch" command line:
+cut&pasted to "git-fetch" command line:
  
  ------------
  Linus, please pull from
@@ -226,14 +233,14 @@ the tag object affects, for example, the ordering of tags in the
  gitweb interface.
  
  To set the date used in future tag objects, set the environment
-variable GIT_AUTHOR_DATE to one or more of the date and time.  The
+variable GIT_COMMITTER_DATE to one or more of the date and time.  The
  date and time can be specified in a number of ways; the most common
  is "YYYY-MM-DD HH:MM".
  
  An example follows.
  
  ------------
-$ GIT_AUTHOR_DATE="2006-10-02 10:31" git tag -s v1.0.1
+$ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
  ------------
  
  
@@ -248,4 +255,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
  
  GIT
  ---
-Part of the linkgit:git[7] suite
+Part of the linkgit:git[1] suite