]> git.ipfire.org Git - thirdparty/git.git/commit
clear_delta_base_cache_entry: use a more descriptive name
authorJeff King <peff@peff.net>
Mon, 22 Aug 2016 21:57:53 +0000 (17:57 -0400)
committerJunio C Hamano <gitster@pobox.com>
Tue, 23 Aug 2016 21:45:29 +0000 (14:45 -0700)
commit4a5397ca79f895e84b3a28abe3ab2e8a0faf3510
tree00b40f45de7b8f4ae74e3afce5b3d0e7e59c1d49
parent85fe35ab9e0d6ded2afa7811e8f345d8dbe08907
clear_delta_base_cache_entry: use a more descriptive name

The delta base cache entries are stored in a fixed-length
hash table. So the way to remove an entry is to "clear" the
slot in the table, and that is what this function does.

However, the name is a leaky abstraction. If we were to
change the hash table implementation, it would no longer be
about "clearing". We should name it after _what_ it does,
not _how_ it does it. I.e., something like "remove" instead
of "clear".

But that does not tell the whole story, either. The subtle
thing about this function is that it removes the entry, but
does not free the entry data. So a more descriptive name is
"detach"; we give ownership of the data buffer to the
caller, and remove any other resources.

This patch uses the name detach_delta_base_cache_entry().
We could further model this after functions like
strbuf_detach(), which pass back all of the detached
information. However, since there are so many bits of
information in the struct (the data, the size, the type),
and so few callers (only one), it's not worth that
awkwardness. The name change and a comment can make the
intent clear.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
sha1_file.c