summaryrefslogtreecommitdiffstats
path: root/git-check-ref-format.html
diff options
context:
space:
mode:
authorJunio C Hamano <junio@hera.kernel.org>2009-03-26 08:39:38 +0000
committerJunio C Hamano <junio@hera.kernel.org>2009-03-26 08:39:38 +0000
commit1de7572eb1aa483cc2aaca1db274928ffc6830f0 (patch)
treeac708c90ee1a4a4765a9e852319760583d609fc6 /git-check-ref-format.html
parent625716ad62c5c0b2c57c90079944a7f6b914bb09 (diff)
downloadgit-htmldocs-1de7572eb1aa483cc2aaca1db274928ffc6830f0.tar.gz
Autogenerated HTML docs for v1.6.2.1-389-geed1
Diffstat (limited to 'git-check-ref-format.html')
-rw-r--r--git-check-ref-format.html42
1 files changed, 21 insertions, 21 deletions
diff --git a/git-check-ref-format.html b/git-check-ref-format.html
index 5f7ca9fa0..f3885950b 100644
--- a/git-check-ref-format.html
+++ b/git-check-ref-format.html
@@ -314,7 +314,7 @@ git-check-ref-format(1) Manual Page
<h2>NAME</h2>
<div class="sectionbody">
<p>git-check-ref-format -
- Make sure ref name is well formed
+ Ensures that a reference name is well formed
</p>
</div>
</div>
@@ -324,60 +324,60 @@ git-check-ref-format(1) Manual Page
</div>
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="para"><p>Checks if a given <em>refname</em> is acceptable, and exits non-zero if
-it is not.</p></div>
+<div class="para"><p>Checks if a given <em>refname</em> is acceptable, and exits with a non-zero
+status if it is not.</p></div>
<div class="para"><p>A reference is used in git to specify branches and tags. A
-branch head is stored under <tt>$GIT_DIR/refs/heads</tt> directory, and
-a tag is stored under <tt>$GIT_DIR/refs/tags</tt> directory. git
-imposes the following rules on how refs are named:</p></div>
+branch head is stored under the <tt>$GIT_DIR/refs/heads</tt> directory, and
+a tag is stored under the <tt>$GIT_DIR/refs/tags</tt> directory. git
+imposes the following rules on how references are named:</p></div>
<div class="olist"><ol>
<li>
<p>
-It can include slash <tt>/</tt> for hierarchical (directory)
+They can include slash <tt>/</tt> for hierarchical (directory)
grouping, but no slash-separated component can begin with a
- dot <tt>.</tt>;
+ dot <tt>.</tt>.
</p>
</li>
<li>
<p>
-It cannot have two consecutive dots <tt>..</tt> anywhere;
+They cannot have two consecutive dots <tt>..</tt> anywhere.
</p>
</li>
<li>
<p>
-It cannot have ASCII control character (i.e. bytes whose
+They cannot have ASCII control characters (i.e. bytes whose
values are lower than \040, or \177 <tt>DEL</tt>), space, tilde <tt>~</tt>,
caret <tt>&#94;</tt>, colon <tt>:</tt>, question-mark <tt>?</tt>, asterisk <tt>*</tt>,
- or open bracket <tt>[</tt> anywhere;
+ or open bracket <tt>[</tt> anywhere.
</p>
</li>
<li>
<p>
-It cannot end with a slash <tt>/</tt>.
+They cannot end with a slash <tt>/</tt>.
</p>
</li>
</ol></div>
-<div class="para"><p>These rules makes it easy for shell script based tools to parse
-refnames, pathname expansion by the shell when a refname is used
+<div class="para"><p>These rules make it easy for shell script based tools to parse
+reference names, pathname expansion by the shell when a reference name is used
unquoted (by mistake), and also avoids ambiguities in certain
-refname expressions (see <a href="git-rev-parse.html">git-rev-parse(1)</a>). Namely:</p></div>
+reference name expressions (see <a href="git-rev-parse.html">git-rev-parse(1)</a>):</p></div>
<div class="olist"><ol>
<li>
<p>
-double-dot <tt>..</tt> are often used as in <tt>ref1..ref2</tt>, and in some
- context this notation means <tt>&#94;ref1 ref2</tt> (i.e. not in
- ref1 and in ref2).
+A double-dot <tt>..</tt> is often used as in <tt>ref1..ref2</tt>, and in some
+ contexts this notation means <tt>&#94;ref1 ref2</tt> (i.e. not in
+ <tt>ref1</tt> and in <tt>ref2</tt>).
</p>
</li>
<li>
<p>
-tilde <tt>~</tt> and caret <tt>&#94;</tt> are used to introduce postfix
+A tilde <tt>~</tt> and caret <tt>&#94;</tt> are used to introduce the postfix
<em>nth parent</em> and <em>peel onion</em> operation.
</p>
</li>
<li>
<p>
-colon <tt>:</tt> is used as in <tt>srcref:dstref</tt> to mean "use srcref's
+A colon <tt>:</tt> is used as in <tt>srcref:dstref</tt> to mean "use srcref's
value and store it in dstref" in fetch and push operations.
It may also be used to select a specific object such as with
'git-cat-file': "git cat-file blob v1.3.3:refs.c".
@@ -391,7 +391,7 @@ colon <tt>:</tt> is used as in <tt>srcref:dstref</tt> to mean "use srcref's
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2009-02-14 08:18:06 UTC
+Last updated 2009-03-26 08:39:13 UTC
</div>
</div>
</body>