development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-27 11:39:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

refname_is_safe(): improve docstring

Browse source 
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Jeff King <peff@peff.net>
This commit is contained in:
Michael Haggerty 2015-11-10 12:42:35 +01:00 committed by Jeff King
parent a935ebd4a7
commit 03b32623d8
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
refs.c
View file

@ -341,13 +341,17 @@ static struct ref_dir *get_ref_dir(struct ref_entry *entry)
} }
/* /*
* Check if a refname is safe. * Return true iff refname is minimally safe. "Safe" here means that
* For refs that start with "refs/" we consider it safe as long they do * deleting a loose reference by this name will not do any damage, for
* not try to resolve to outside of refs/. * example by causing a file that is not a reference to be deleted.
* This function does not check that the reference name is legal; for
* that, use check_refname_format().
* *
* For all other refs we only consider them safe iff they only contain * We consider a refname that starts with "refs/" to be safe as long
* upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like * as any ".." components that it might contain do not escape "refs/".
* "config"). * 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").
*/ */
static int refname_is_safe(const char *refname) static int refname_is_safe(const char *refname)
{ {