Revert "filter-branch docs: remove brackets so not to imply revision arg is optional"
[gitweb.git] / Documentation / git-check-ref-format.txt
index 7dc1bdb6ef62f1325f8cf0567aa65c56728522ec..a676880429086a7f65cf3264bf98b379bc9c22ec 100644 (file)
@@ -19,8 +19,9 @@ 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:
 
-. 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 `.`;
 
 . It cannot have two consecutive dots `..` anywhere;
 
@@ -34,7 +35,7 @@ imposes the following rules on how refs are named:
 These rules makes 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:
+refname expressions (see linkgit:git-rev-parse[1]).  Namely:
 
 . double-dot `..` are often used as in `ref1..ref2`, and in some
   context this notation means `{caret}ref1 ref2` (i.e. not in
@@ -45,8 +46,10 @@ refname expressions (see gitlink:git-rev-parse[1]).  Namely:
 
 . 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
+  linkgit:git-cat-file[1] "git-cat-file blob v1.3.3:refs.c".
 
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite