[PATCH/RFC 05/12] docs: differentiate between <tag> and <tagname>
- From
Mark Lodato <lodatom@gmail.com>
- Date
- Mar 13, 2010, 04:52 UTC
- Message-ID
- <1268455984-19061-6-git-send-email-lodatom@gmail.com>
- In-Reply-To
- <1268455984-19061-1-git-send-email-lodatom@gmail.com>
In the documentation and user messages, differentiate between <tag>, which means an actual annotated tag object, and <tagname>, which is a revision specifier for refs/tags/<tagname>.
Signed-off-by: Mark Lodato <lodatom@gmail.com> --- A similar thing should be done for <head> vs <branch> vs <branchname>. The term <head> is not used anywhere to mean what it does in git(1); instead, it is used as a more descriptive term for <commit-ish>. The term <branchname> is used for what git(1) describes as <head>, but the term <branch> is also used, and I'm not sure what it means. I'll have to look into this.
Documentation/git-push.txt | 2 +- Documentation/git.txt | 8 ++++++-- Documentation/pull-fetch-param.txt | 2 +- builtin/push.c | 2 +- 4 files changed, 9 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index 49b6bd9..5445443 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -55,7 +55,7 @@ you can tell git to update the <dst> ref even when the update is not a fast-forward. This does *not* attempt to merge <src> into <dst>. See EXAMPLES below for details. + -`tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`. +`tag <tagname>` means the same as `refs/tags/<tagname>:refs/tags/<tagname>`. + Pushing an empty <src> allows you to delete the <dst> ref from the remote repository. diff --git a/Documentation/git.txt b/Documentation/git.txt index a635281..f06e4de 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -420,6 +420,10 @@ Identifier Terminology <object>:: Indicates the object name for any type of object. +<tag>:: + Indicates a tag object name. This is an annotated tag object, as + opposed to <tagname>, which can refer to any type of object. + <blob>:: Indicates a blob object name. @@ -458,9 +462,9 @@ HEAD:: indicates the head of the current branch (i.e. the contents of `$GIT_DIR/HEAD`). -<tag>:: +<tagname>:: a valid tag 'name' - (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`). + (i.e. the contents of `$GIT_DIR/refs/tags/<tagname>`). <head>:: a valid head 'name' diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt index 5dd6e5a..3a947b3 100644 --- a/Documentation/pull-fetch-param.txt +++ b/Documentation/pull-fetch-param.txt @@ -66,7 +66,7 @@ is often useful. + Some short-cut notations are also supported. + -* `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`; +* `tag <tagname>` means the same as `refs/tags/<tagname>:refs/tags/<tagname>`; it requests fetching everything up to the given tag. * A parameter <ref> without a colon is equivalent to <ref>: when pulling/fetching, so it merges <ref> into the current diff --git a/builtin/push.c b/builtin/push.c index f7bc2b2..4227a8e 100644 --- a/builtin/push.c +++ b/builtin/push.c @@ -38,7 +38,7 @@ static void set_refspecs(const char **refs, int nr) char *tag; int len; if (nr <= ++i) - die("tag shorthand without <tag>"); + die("tag shorthand without <tagname>"); len = strlen(refs[i]) + 11; if (deleterefs) { tag = xmalloc(len+1);
-- 1.7.0.2