From: David Turner Date: Mon, 28 Sep 2015 22:01:59 GMT Subject: [PATCH v2 24/43] refs.h: document make refname_is_safe and add it to header Message-ID: <1443477738-32023-25-git-send-email-dturner@twopensource.com> In-Reply-To: <1443477738-32023-1-git-send-email-dturner@twopensource.com> This function might be used by other refs backends Signed-off-by: David Turner --- refs.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/refs.h b/refs.h index 2bafa55..db60bfe 100644 --- a/refs.h +++ b/refs.h @@ -259,6 +259,17 @@ int verify_refname_available(const char *newname, struct string_list *extra, struct string_list *skip, struct strbuf *err); /* + * Check if a refname is safe. + * For refs that start with "refs/" we consider it safe as long they do + * not try to resolve to outside of refs/. + * + * For all other refs we only consider them safe iff they only contain + * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like + * "config"). + */ +int refname_is_safe(const char *refname); + +/* * Flags controlling ref_transaction_update(), ref_transaction_create(), etc. * REF_NODEREF: act on the ref directly, instead of dereferencing * symbolic references. -- 2.4.2.644.g97b850b-twtrsrc