git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sean <seanlkml@sympatico.ca>
To: git@vger.kernel.org
Subject: [PATCH] Minor addition to git-check-ref-format man page
Date: Sun, 15 Jul 2007 08:18:08 -0400	[thread overview]
Message-ID: <20070715081808.17e0564e.seanlkml@sympatico.ca> (raw)


Mention that refname must include at least one slash to
be considered valid.

Signed-off-by: Sean Estabrooks <seanlkml@sympatico.ca>
---
 Documentation/git-check-ref-format.txt |   10 ++++++----
 1 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt
index 13a5f43..4f80053 100644
--- a/Documentation/git-check-ref-format.txt
+++ b/Documentation/git-check-ref-format.txt
@@ -11,11 +11,13 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-Checks if a given 'refname' is acceptable, and exits non-zero if
-it is not.
+Checks if a given 'refname' is acceptable and exits with zero if
+it is all right.  To be considered acceptable, the refname must
+contain at least one slash '/' character (eg. heads/master).
 
 A reference is used in git to specify branches and tags.  A
-branch head is stored under `$GIT_DIR/refs/heads` directory, and
+branch head is stored under `$GIT_DIR/refs/heads` directory, a
+remote-branch head is stored under `$GIT_DIR/refs/remotes`, and
 a tag is stored under `$GIT_DIR/refs/tags` directory.  git
 imposes the following rules on how refs are named:
 
@@ -32,7 +34,7 @@ imposes the following rules on how refs are named:
 
 . It cannot end with a slash `/`.
 
-These rules makes it easy for shell script based tools to parse
+These rules make it easy for shell script based tools to parse
 refnames, pathname expansion by the shell when a refname is used
 unquoted (by mistake), and also avoids ambiguities in certain
 refname expressions (see gitlink:git-rev-parse[1]).  Namely:
-- 
1.5.2.2

                 reply	other threads:[~2007-07-15 12:20 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20070715081808.17e0564e.seanlkml@sympatico.ca \
    --to=seanlkml@sympatico.ca \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).