Browse Source

git tag documentation grammar fixes and readability updates

... with help from Eric Raible.

In addition, describe the use of GIT_COMMITTER_DATE more comprehensively
by including "date-formats.txt"

Signed-off-by: Michael Witten <mfwitten@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Michael Witten 14 years ago committed by Junio C Hamano
parent
commit
f1723ee6b3
  1. 36
      Documentation/git-tag.txt

36
Documentation/git-tag.txt

@ -165,13 +165,12 @@ You can test which tag you have by doing @@ -165,13 +165,12 @@ You can test which tag you have by doing

which should return 0123456789abcdef.. if you have the new version.

Sorry for inconvenience.
Sorry for the inconvenience.
------------

Does this seem a bit complicated? It *should* be. There is no
way that it would be correct to just "fix" it behind peoples
backs. People need to know that their tags might have been
changed.
way that it would be correct to just "fix" it automatically.
People need to know that their tags might have been changed.


On Automatic following
@ -189,9 +188,10 @@ the toplevel but not limited to them. Mere mortals when pulling @@ -189,9 +188,10 @@ the toplevel but not limited to them. Mere mortals when pulling
from each other do not necessarily want to automatically get
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 a 'git fetch' command line:
Often, "please pull" messages on the mailing list just provide
two pieces of information: a repo URL and a branch name; this
is designed to be easily cut&pasted at the end of a 'git fetch'
command line:

------------
Linus, please pull from
@ -207,14 +207,14 @@ becomes: @@ -207,14 +207,14 @@ becomes:
$ git pull git://git..../proj.git master
------------

In such a case, you do not want to automatically follow other's
tags.
In such a case, you do not want to automatically follow the other
person's tags.

One important aspect of git is it is distributed, and being
distributed largely means there is no inherent "upstream" or
One important aspect of git is its distributed nature, which
largely means there is no inherent "upstream" or
"downstream" in the system. On the face of it, the above
example might seem to indicate that the tag namespace is owned
by upper echelon of people and tags only flow downwards, but
by the upper echelon of people and that tags only flow downwards, but
that is not the case. It only shows that the usage pattern
determines who are interested in whose tags.

@ -232,7 +232,7 @@ this case. @@ -232,7 +232,7 @@ this case.

It may well be that among networking people, they may want to
exchange the tags internal to their group, but in that workflow
they are most likely tracking with each other's progress by
they are most likely tracking each other's progress by
having remote-tracking branches. Again, the heuristic to automatically
follow such tags is a good thing.

@ -242,21 +242,21 @@ On Backdating Tags @@ -242,21 +242,21 @@ On Backdating Tags

If you have imported some changes from another VCS and would like
to add tags for major releases of your work, it is useful to be able
to specify the date to embed inside of the tag object. The data in
to specify the date to embed inside of the tag object; such data in
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_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".
variable GIT_COMMITTER_DATE (see the later discussion of possible
values; the most common form is "YYYY-MM-DD HH:MM").

An example follows.
For example:

------------
$ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
------------

include::date-formats.txt[]

SEE ALSO
--------

Loading…
Cancel
Save