git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] Reference git-check-ref-format in git-branch.

From
Shawn Pearce <spearce@spearce.org>
Date
May 21, 2006, 01:54 UTC
Message-ID
<20060521015446.GA7605@spearce.org>

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>
---
 Sorry about this patch being built on pu.  It clearly has no
 relationship to current pu, but the new -l appears in the hunk
 below...
1e2080dcf2f8e76e0fcf48684e5c6b182f695e0a
 Documentation/git-branch.txt   |    3 +++
 Documentation/git-checkout.txt |    5 ++++-
 2 files changed, 7 insertions(+), 1 deletions(-)
1e2080dcf2f8e76e0fcf48684e5c6b182f695e0a
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index a7bec3c..d43ef1d 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -49,6 +49,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
index 0643943..fbdbadc 100644
--- 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.
 
 -l::
 	Create the new branch's ref log.  This activates recording of
-- 
1.3.3.gfad60
Next: Junio C Hamano
Message 1 of 2 in “Reference git-check-ref-format in git-branch.”
  1. Reference git-check-ref-format in git-branch.Shawn Pearce, May 21, 2006
  2. Junio C HamanoMay 21, 2006

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.