summaryrefslogtreecommitdiffstats
path: root/git-check-ref-format.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-11-10 15:01:12 +0900
committerJunio C Hamano <gitster@pobox.com>2017-11-10 15:01:12 +0900
commit3a9c034734bf5aa3e3b139e72a6b0b96ddf0b3e9 (patch)
tree53a0176d8d930235e125d80c7705681f80bf1957 /git-check-ref-format.html
parenta65b67605da51cd9b94659acdac8984dd205dcc7 (diff)
downloadgit-htmldocs-3a9c034734bf5aa3e3b139e72a6b0b96ddf0b3e9.tar.gz
Autogenerated HTML docs for v2.15.0-164-g4123b
Diffstat (limited to 'git-check-ref-format.html')
-rw-r--r--git-check-ref-format.html11
1 files changed, 9 insertions, 2 deletions
diff --git a/git-check-ref-format.html b/git-check-ref-format.html
index 62ed0cc1f..d4cdf1c95 100644
--- a/git-check-ref-format.html
+++ b/git-check-ref-format.html
@@ -863,7 +863,14 @@ at-open-brace <code>@{</code> is used as a notation to access a reflog entry.
</p>
</li>
</ol></div>
-<div class="paragraph"><p>With the <code>--branch</code> option, it expands the &#8220;previous branch syntax&#8221;
+<div class="paragraph"><p>With the <code>--branch</code> option, the command takes a name and checks if
+it can be used as a valid branch name (e.g. when creating a new
+branch). The rule <code>git check-ref-format --branch $name</code> implements
+may be stricter than what <code>git check-ref-format refs/heads/$name</code>
+says (e.g. a dash may appear at the beginning of a ref component,
+but it is explicitly forbidden at the beginning of a branch name).
+When run with <code>--branch</code> option in a repository, the input is first
+expanded for the &#8220;previous branch syntax&#8221;
<code>@{-n}</code>. For example, <code>@{-1}</code> is a way to refer the last branch you
were on. This option should be used by porcelains to accept this
syntax anywhere a branch name is expected, so they can act as if you
@@ -948,7 +955,7 @@ Determine the reference name to use for a new branch:
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-02-25 04:00:28 JST
+Last updated 2017-11-10 15:00:41 JST
</div>
</div>
</body>