From: Michael Haggerty <mhagger@alum.mit.edu>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Jeff King <peff@peff.net>,
David Turner <novalis@novalis.org>,
Jacob Keller <jacob.keller@gmail.com>,
Philip Oakley <philipoakley@iee.org>,
Michael Haggerty <mhagger@alum.mit.edu>
Subject: [PATCH v4 02/23] refname_is_safe(): correct docstring
Date: Fri, 6 Jan 2017 17:22:22 +0100 [thread overview]
Message-ID: <bda5573d25412123683c36c2ea6669aa6f380c61.1483719289.git.mhagger@alum.mit.edu> (raw)
In-Reply-To: <cover.1483719289.git.mhagger@alum.mit.edu>
The behavior of refname_is_safe() was changed in
e40f355 "refname_is_safe(): insist that the refname already be normalized", 2016-04-27
without a corresponding update to its docstring. The function is in fact
stricter than documented, because it now insists that the result of
normalizing the part of a refname following "refs/" is identical to that
part of the original refname. Fix the docstring.
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
---
refs/refs-internal.h | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/refs/refs-internal.h b/refs/refs-internal.h
index 708b260..dc81acc 100644
--- a/refs/refs-internal.h
+++ b/refs/refs-internal.h
@@ -62,11 +62,12 @@
* This function does not check that the reference name is legal; for
* that, use check_refname_format().
*
- * We consider a refname that starts with "refs/" to be safe as long
- * as any ".." components that it might contain do not escape "refs/".
- * Names that do not start with "refs/" are considered safe iff they
- * consist entirely of upper case characters and '_' (like "HEAD" and
- * "MERGE_HEAD" but not "config" or "FOO/BAR").
+ * A refname that starts with "refs/" is considered safe iff it
+ * doesn't contain any "." or ".." components or consecutive '/'
+ * characters, end with '/', or (on Windows) contain any '\'
+ * characters. Names that do not start with "refs/" are considered
+ * safe iff they consist entirely of upper case characters and '_'
+ * (like "HEAD" and "MERGE_HEAD" but not "config" or "FOO/BAR").
*/
int refname_is_safe(const char *refname);
--
2.9.3
next prev parent reply other threads:[~2017-01-06 16:23 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-06 16:22 [PATCH v4 00/23] Delete directories left empty after ref deletion Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 01/23] files_rename_ref(): tidy up whitespace Michael Haggerty
2017-01-06 16:22 ` Michael Haggerty [this message]
2017-01-06 16:22 ` [PATCH v4 03/23] t5505: use "for-each-ref" to test for the non-existence of references Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 04/23] safe_create_leading_directories_const(): preserve errno Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 05/23] safe_create_leading_directories(): set errno on SCLD_EXISTS Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 06/23] raceproof_create_file(): new function Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 07/23] lock_ref_sha1_basic(): inline constant Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 08/23] lock_ref_sha1_basic(): use raceproof_create_file() Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 09/23] rename_tmp_log(): " Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 10/23] rename_tmp_log(): improve error reporting Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 11/23] log_ref_write(): inline function Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 12/23] log_ref_setup(): separate code for create vs non-create Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 13/23] log_ref_setup(): improve robustness against races Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 14/23] log_ref_setup(): pass the open file descriptor back to the caller Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 15/23] log_ref_write_1(): don't depend on logfile argument Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 16/23] log_ref_setup(): manage the name of the reflog file internally Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 17/23] log_ref_write_1(): inline function Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 18/23] delete_ref_loose(): derive loose reference path from lock Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 19/23] delete_ref_loose(): inline function Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 20/23] try_remove_empty_parents(): rename parameter "name" -> "refname" Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 21/23] try_remove_empty_parents(): don't trash argument contents Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 22/23] try_remove_empty_parents(): teach to remove parents of reflogs, too Michael Haggerty
2017-01-06 16:22 ` [PATCH v4 23/23] files_transaction_commit(): clean up empty directories Michael Haggerty
2017-01-06 19:44 ` [PATCH v4 00/23] Delete directories left empty after ref deletion Jeff King
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=bda5573d25412123683c36c2ea6669aa6f380c61.1483719289.git.mhagger@alum.mit.edu \
--to=mhagger@alum.mit.edu \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jacob.keller@gmail.com \
--cc=novalis@novalis.org \
--cc=peff@peff.net \
--cc=philipoakley@iee.org \
/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).