diff_unique_abbrev: rename to diff_aligned_abbrev

The word "align" describes how the function actually differs
from find_unique_abbrev, and will make it less confusing
when we add more diff-specific abbrevation functions that do
not do this alignment.

Since this is a globally available function, let's also move
its descriptive comment to the header file, where we
typically document function interfaces.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jeff King
2016-10-20 02:19:43 -04:00
committed by Junio C Hamano
parent ef2ed5013c
commit d5e3b01e5b
3 changed files with 11 additions and 11 deletions

6
diff.h
View File

@ -340,7 +340,11 @@ extern void diff_warn_rename_limit(const char *varname, int needed, int degraded
#define DIFF_STATUS_FILTER_AON '*'
#define DIFF_STATUS_FILTER_BROKEN 'B'
extern const char *diff_unique_abbrev(const unsigned char *, int);
/*
* This is different from find_unique_abbrev() in that
* it stuffs the result with dots for alignment.
*/
extern const char *diff_aligned_abbrev(const unsigned char *sha1, int);
/* do not report anything on removed paths */
#define DIFF_SILENT_ON_REMOVED 01