git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Minor addition to git-check-ref-format man page
@ 2007-07-15 12:18 Sean
  0 siblings, 0 replies; only message in thread
From: Sean @ 2007-07-15 12:18 UTC (permalink / raw)
  To: git


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

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2007-07-15 12:20 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2007-07-15 12:18 [PATCH] Minor addition to git-check-ref-format man page Sean

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).