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 1/8] interpret_branch_name: move docstring to header file
Date: Thu, 2 Mar 2017 03:21:23 -0500 [thread overview]
Message-ID: <20170302082123.5flyazh5vll4ce7t@sigill.intra.peff.net> (raw)
In-Reply-To: <20170302082100.edaretznmlralswa@sigill.intra.peff.net>
We generally put docstrings with function declarations,
because it's the callers who need to know how the function
works. Let's do so for interpret_branch_name().
Signed-off-by: Jeff King <peff@peff.net>
---
cache.h | 21 +++++++++++++++++++++
sha1_name.c | 21 ---------------------
2 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/cache.h b/cache.h
index 80b6372cf..c67995caa 100644
--- a/cache.h
+++ b/cache.h
@@ -1363,6 +1363,27 @@ extern char *oid_to_hex_r(char *out, const struct object_id *oid);
extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
+/*
+ * This reads short-hand syntax that not only evaluates to a commit
+ * object name, but also can act as if the end user spelled the name
+ * of the branch from the command line.
+ *
+ * - "@{-N}" finds the name of the Nth previous branch we were on, and
+ * places the name of the branch in the given buf and returns the
+ * number of characters parsed if successful.
+ *
+ * - "<branch>@{upstream}" finds the name of the other ref that
+ * <branch> is configured to merge with (missing <branch> defaults
+ * to the current branch), and places the name of the branch in the
+ * given buf and returns the number of characters parsed if
+ * successful.
+ *
+ * If the input is not of the accepted format, it returns a negative
+ * number to signal an error.
+ *
+ * If the input was ok but there are not N branch switches in the
+ * reflog, it returns 0.
+ */
extern int interpret_branch_name(const char *str, int len, struct strbuf *);
extern int get_oid_mb(const char *str, struct object_id *oid);
diff --git a/sha1_name.c b/sha1_name.c
index 9b5d14b4b..28865b3a1 100644
--- a/sha1_name.c
+++ b/sha1_name.c
@@ -1238,27 +1238,6 @@ static int interpret_branch_mark(const char *name, int namelen,
return len + at;
}
-/*
- * This reads short-hand syntax that not only evaluates to a commit
- * object name, but also can act as if the end user spelled the name
- * of the branch from the command line.
- *
- * - "@{-N}" finds the name of the Nth previous branch we were on, and
- * places the name of the branch in the given buf and returns the
- * number of characters parsed if successful.
- *
- * - "<branch>@{upstream}" finds the name of the other ref that
- * <branch> is configured to merge with (missing <branch> defaults
- * to the current branch), and places the name of the branch in the
- * given buf and returns the number of characters parsed if
- * successful.
- *
- * If the input is not of the accepted format, it returns a negative
- * number to signal an error.
- *
- * If the input was ok but there are not N branch switches in the
- * reflog, it returns 0.
- */
int interpret_branch_name(const char *name, int namelen, struct strbuf *buf)
{
char *at;
--
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 ` Jeff King [this message]
2017-03-02 8:21 ` [PATCH v2 2/8] strbuf_branchname: drop return value Jeff King
2017-03-02 8:21 ` [PATCH v2 3/8] strbuf_branchname: add docstring Jeff King
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=20170302082123.5flyazh5vll4ce7t@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).