From: Jeff King <peff@peff.net>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
Jacob Keller <jacob.keller@gmail.com>
Subject: [PATCH v2 3/8] strbuf_branchname: add docstring
Date: Thu, 2 Mar 2017 03:21:30 -0500 [thread overview]
Message-ID: <20170302082130.ynfctf73qbvwt3qo@sigill.intra.peff.net> (raw)
In-Reply-To: <20170302082100.edaretznmlralswa@sigill.intra.peff.net>
This function and its companion, strbuf_check_branch_ref(),
did not have their purpose or semantics explained. Let's do
so.
Signed-off-by: Jeff King <peff@peff.net>
---
strbuf.h | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/strbuf.h b/strbuf.h
index 47df0500d..6b51b2604 100644
--- a/strbuf.h
+++ b/strbuf.h
@@ -560,7 +560,22 @@ static inline void strbuf_complete_line(struct strbuf *sb)
strbuf_complete(sb, '\n');
}
+/*
+ * Copy "name" to "sb", expanding any special @-marks as handled by
+ * interpret_branch_name(). The result is a non-qualified branch name
+ * (so "foo" or "origin/master" instead of "refs/heads/foo" or
+ * "refs/remotes/origin/master").
+ *
+ * Note that the resulting name may not be a syntactically valid refname.
+ */
extern void strbuf_branchname(struct strbuf *sb, const char *name);
+
+/*
+ * Like strbuf_branchname() above, but confirm that the result is
+ * syntactically valid to be used as a local branch name in refs/heads/.
+ *
+ * The return value is "0" if the result is valid, and "-1" otherwise.
+ */
extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
--
2.12.0.367.gb23790f66
next prev parent reply other threads:[~2017-03-02 8:28 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-02 8:21 [PATCH v2] fixing corner-cases with interpret_branch_name() Jeff King
2017-03-02 8:21 ` [PATCH v2 1/8] interpret_branch_name: move docstring to header file Jeff King
2017-03-02 8:21 ` [PATCH v2 2/8] strbuf_branchname: drop return value Jeff King
2017-03-02 8:21 ` Jeff King [this message]
2017-03-02 8:23 ` [PATCH v2 4/8] interpret_branch_name: allow callers to restrict expansions Jeff King
2017-03-02 8:23 ` [PATCH v2 5/8] t3204: test git-branch @-expansion corner cases Jeff King
2017-03-02 8:23 ` [PATCH v2 6/8] branch: restrict @-expansions when deleting Jeff King
2017-03-02 8:23 ` [PATCH v2 7/8] strbuf_check_ref_format(): expand only local branches Jeff King
2017-03-02 8:23 ` [PATCH v2 8/8] checkout: restrict @-expansions when finding branch Jeff King
2017-03-02 8:47 ` [PATCH v2] fixing corner-cases with interpret_branch_name() Jacob Keller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170302082130.ynfctf73qbvwt3qo@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jacob.keller@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).