Autogenerated man pages for v1.4.0-rc1-gfd7e
[git.git] / man1 / git-check-ref-format.1
index 3b7ee77..ff61111 100755 (executable)
 ..
 .TH "GIT-CHECK-REF-FORM" 1 "" "" ""
 .SH NAME
-git-check-ref-format \- Make sure ref name is well formed.
+git-check-ref-format \- Make sure ref name is well formed
 .SH "SYNOPSIS"
 
 
-git\-check\-ref\-format <refname>
+\fIgit\-check\-ref\-format\fR <refname>
 
 .SH "DESCRIPTION"
 
 
-Checks if a given refname is acceptable, and exits non\-zero if it is not\&.
+Checks if a given \fIrefname\fR is acceptable, and exits non\-zero if it is not\&.
 
 
 A reference is used in git to specify branches and tags\&. A branch head is stored under $GIT_DIR/refs/heads directory, and a tag is stored under $GIT_DIR/refs/tags directory\&. git imposes the following rules on how refs are named:
 
 .TP 3
 1.
-It could be named hierarchically (i\&.e\&. separated with slash /), but each of its component cannot begin with a dot \&.;
+It can include slash / for hierarchical (directory) grouping, but no slash\-separated component can begin with a dot \&.;
 .TP
 2.
 It cannot have two consecutive dots \&.\&. anywhere;
@@ -55,10 +55,10 @@ These rules makes it easy for shell script based tools to parse refnames, pathna
 double\-dot \&.\&. are often used as in ref1\&.\&.ref2, and in some context this notation means ^ref1 ref2 (i\&.e\&. not in ref1 and in ref2)\&.
 .TP
 2.
-tilde ~ and caret ^ are used to introduce postfix nth parent and peel onion operation\&.
+tilde ~ and caret ^ are used to introduce postfix \fInth parent\fR and \fIpeel onion\fR operation\&.
 .TP
 3.
-colon : is used as in srcref:dstref to mean "use srcref's value and store it in dstref" in fetch and push operations\&.
+colon : is used as in srcref:dstref 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 \fBgit\-cat\-file\fR(1) "git\-cat\-file blob v1\&.3\&.3:refs\&.c"\&.
 .LP
 
 .SH "GIT"