From b85e6c5f8107c802c627981e044e680999884c5f Mon Sep 17 00:00:00 2001 From: Nanako Shiraishi Date: Sat, 22 Aug 2009 09:45:18 +0900 Subject: [PATCH] Documentation: consistently refer to check-ref-format Change the placeholder to in the SYNOPSIS section of git-tag documentation, and describe it in the OPTIONS section in a way similar to how documentation for git-branch does. Add SEE ALSO section to list the other documentation pages these two pages refer to. Signed-off-by: Nanako Shiraishi Signed-off-by: Junio C Hamano --- Documentation/git-branch.txt | 6 ++++++ Documentation/git-tag.txt | 20 ++++++++++++++------ 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index ae201deb7..99988872e 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -209,6 +209,12 @@ but different purposes: - `--no-merged` is used to find branches which are candidates for merging into HEAD, since those branches are not fully contained by HEAD. +SEE ALSO +-------- +linkgit:git-check-ref-format[1], +linkgit:git-fetch[1], +linkgit:git-remote[1]. + Author ------ Written by Linus Torvalds and Junio C Hamano diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 1118ce22d..5113eaec6 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -10,17 +10,15 @@ SYNOPSIS -------- [verse] 'git tag' [-a | -s | -u ] [-f] [-m | -F ] - [ | ] -'git tag' -d ... + [ | ] +'git tag' -d ... 'git tag' [-n[]] -l [--contains ] [] -'git tag' -v ... +'git tag' -v ... DESCRIPTION ----------- -Adds a 'tag' reference in `.git/refs/tags/`. The tag must pass -linkgit:git-check-ref-format[1] which basicly means that control characters, -space, ~, ^, :, ?, *, [ and \ are prohibited. +Adds a tag reference in `.git/refs/tags/`. Unless `-f` is given, the tag must not yet exist in `.git/refs/tags/` directory. @@ -88,6 +86,12 @@ OPTIONS Implies `-a` if none of `-a`, `-s`, or `-u ` is given. +:: + The name of the tag to create, delete, or describe. + The new tag name must pass all checks defined by + linkgit:git-check-ref-format[1]. Some of these checks + may restrict the characters allowed in a tag name. + CONFIGURATION ------------- By default, 'git-tag' in sign-with-default mode (-s) will use your @@ -252,6 +256,10 @@ $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1 ------------ +SEE ALSO +-------- +linkgit:git-check-ref-format[1]. + Author ------ Written by Linus Torvalds , -- 2.30.2