Reference git-check-ref-format in git-branch.

spearce · Junio C Hamano · commit 2b1f4247ab58 · 2006-05-21T02:05:41.000-07:00
Its nice to have git-check-ref-format actually get mentioned in
git-branch's documentation as the syntax of a ref name must conform
to what is described in git-check-ref-format.

Signed-off-by: Shawn O. Pearce &lt;spearce@spearce.org&gt;
Signed-off-by: Junio C Hamano &lt;junkio@cox.net&gt;
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
@@ -43,6 +43,9 @@ OPTIONS
 
 <branchname>::
 	The name of the branch to create or delete.
+	The new branch name must pass all checks defined by
+	gitlink:git-check-ref-format[1].  Some of these checks
+	may restrict the characters allowed in a branch name.
 
 <start-point>::
 	The new branch will be created with a HEAD equal to this.  It may
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
@@ -35,7 +35,10 @@ OPTIONS
 	Force a re-read of everything.
 
 -b::
-	Create a new branch and start it at <branch>.
+	Create a new branch named <new_branch> and start it at
+	<branch>.  The new branch name must pass all checks defined
+	by gitlink:git-check-ref-format[1].  Some of these checks
+	may restrict the characters allowed in a branch name.
 
 -m::
 	If you have local modifications to one or more files that
