Skip to content

Commit f1723ee

Browse files
mfwittengitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 7d6cb10 commit f1723ee

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

Documentation/git-tag.txt

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -165,13 +165,12 @@ You can test which tag you have by doing
165165

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

168-
Sorry for inconvenience.
168+
Sorry for the inconvenience.
169169
------------
170170

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

176175

177176
On Automatic following
@@ -189,9 +188,10 @@ the toplevel but not limited to them. Mere mortals when pulling
189188
from each other do not necessarily want to automatically get
190189
private anchor point tags from the other person.
191190

192-
You would notice "please pull" messages on the mailing list says
193-
repo URL and branch name alone. This is designed to be easily
194-
cut&pasted to a 'git fetch' command line:
191+
Often, "please pull" messages on the mailing list just provide
192+
two pieces of information: a repo URL and a branch name; this
193+
is designed to be easily cut&pasted at the end of a 'git fetch'
194+
command line:
195195

196196
------------
197197
Linus, please pull from
@@ -207,14 +207,14 @@ becomes:
207207
$ git pull git://git..../proj.git master
208208
------------
209209

210-
In such a case, you do not want to automatically follow other's
211-
tags.
210+
In such a case, you do not want to automatically follow the other
211+
person's tags.
212212

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

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

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

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

243243
If you have imported some changes from another VCS and would like
244244
to add tags for major releases of your work, it is useful to be able
245-
to specify the date to embed inside of the tag object. The data in
245+
to specify the date to embed inside of the tag object; such data in
246246
the tag object affects, for example, the ordering of tags in the
247247
gitweb interface.
248248

249249
To set the date used in future tag objects, set the environment
250-
variable GIT_COMMITTER_DATE to one or more of the date and time. The
251-
date and time can be specified in a number of ways; the most common
252-
is "YYYY-MM-DD HH:MM".
250+
variable GIT_COMMITTER_DATE (see the later discussion of possible
251+
values; the most common form is "YYYY-MM-DD HH:MM").
253252

254-
An example follows.
253+
For example:
255254

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

259+
include::date-formats.txt[]
260260

261261
SEE ALSO
262262
--------

0 commit comments

Comments
 (0)