From d5e3b01e5bd6b06c06dbd5d1e2257d57e6b1deb7 Mon Sep 17 00:00:00 2001 From: Jeff King Date: Thu, 20 Oct 2016 02:19:43 -0400 Subject: 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 Signed-off-by: Junio C Hamano --- diff.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'diff.h') diff --git a/diff.h b/diff.h index 25ae60d5f..f2b04b6d8 100644 --- a/diff.h +++ b/diff.h @@ -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 -- cgit v1.2.1