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

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 <spearce@spearce.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>

diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 72fb2f89b48ea1b80cd6c4a0bd57a9122e59ad79..0b37e2bfc85706ca6d41c1c9e4fedcdce53a7578 100644 (file)
--- 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.
 
 <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
 
 <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
index 095128906a523cc8ca30639c1d42452a4bcb0050..d82efc00d403dc13ac1e85c53083ccc52a4c79f3 100644 (file)
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -35,7 +35,10 @@ OPTIONS
        Force a re-read of everything.
 
 -b::
        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
 
 -m::
        If you have local modifications to one or more files that