rename_ref_available(): add docstring
And improve the internal variable names. Signed-off-by: David Turner <dturner@twopensource.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:

committed by
Junio C Hamano

parent
f6e75467ca
commit
ff3a299c45
@ -240,7 +240,17 @@ const char *find_descendant_ref(const char *dirname,
|
||||
const struct string_list *extras,
|
||||
const struct string_list *skip);
|
||||
|
||||
int rename_ref_available(const char *oldname, const char *newname);
|
||||
/*
|
||||
* Check whether an attempt to rename old_refname to new_refname would
|
||||
* cause a D/F conflict with any existing reference (other than
|
||||
* possibly old_refname). If there would be a conflict, emit an error
|
||||
* message and return false; otherwise, return true.
|
||||
*
|
||||
* Note that this function is not safe against all races with other
|
||||
* processes (though rename_ref() catches some races that might get by
|
||||
* this check).
|
||||
*/
|
||||
int rename_ref_available(const char *old_refname, const char *new_refname);
|
||||
|
||||
/* We allow "recursive" symbolic refs. Only within reason, though */
|
||||
#define SYMREF_MAXDEPTH 5
|
||||
|
Reference in New Issue
Block a user