midx: rename `get_midx_checksum()` to `midx_get_checksum_hash()`

Since 541204aabea (Documentation: document naming schema for structs and
their functions, 2024-07-30), we have adopted a naming convention for
functions that would prefer a name like, say, `midx_get_checksum()` over
`get_midx_checksum()`.

Adopt this convention throughout the midx.h API. Since this function
returns a raw (that is, non-hex encoded) hash, let's suffix the function
with "_hash()" to make this clear. As a side effect, this prepares us
for the subsequent change which will introduce a "_hex()" variant that
encodes the checksum itself.

Suggested-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Taylor Blau <me@ttaylorr.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/midx-write.c b/midx-write.c
index 6485cb6706855363d599a97db013edf8533e121d..73d33752ef11199fd3da6980e76bd37d98f7489e 100644 (file)
--- a/midx-write.c
+++ b/midx-write.c
@@ -946,7 +946,7 @@ static int link_midx_to_chain(struct multi_pack_index *m)
        }
 
        for (i = 0; i < ARRAY_SIZE(midx_exts); i++) {
-               const unsigned char *hash = get_midx_checksum(m);
+               const unsigned char *hash = midx_get_checksum_hash(m);
 
                get_midx_filename_ext(m->source, &from,
                                      hash, midx_exts[i].non_split);
@@ -1151,7 +1151,7 @@ static int write_midx_internal(struct odb_source *source,
                while (m) {
                        if (flags & MIDX_WRITE_BITMAP && load_midx_revindex(m)) {
                                error(_("could not load reverse index for MIDX %s"),
-                                     hash_to_hex_algop(get_midx_checksum(m),
+                                     hash_to_hex_algop(midx_get_checksum_hash(m),
                                                        m->source->odb->repo->hash_algo));
                                goto cleanup;
                        }
@@ -1520,7 +1520,7 @@ static int write_midx_internal(struct odb_source *source,
                for (uint32_t i = 0; i < ctx.num_multi_pack_indexes_before; i++) {
                        uint32_t j = ctx.num_multi_pack_indexes_before - i - 1;
 
-                       keep_hashes[j] = xstrdup(hash_to_hex_algop(get_midx_checksum(m),
+                       keep_hashes[j] = xstrdup(hash_to_hex_algop(midx_get_checksum_hash(m),
                                                                   r->hash_algo));
                        m = m->base_midx;
                }

diff --git a/midx.c b/midx.c
index 4c90eb04c64c8f640ff031fda169cd545b340b25..554bdfc505baea06e042f286f7b3a623c175a2f9 100644 (file)
--- a/midx.c
+++ b/midx.c
@@ -24,7 +24,7 @@ void clear_incremental_midx_files_ext(struct odb_source *source, const char *ext
 int cmp_idx_or_pack_name(const char *idx_or_pack_name,
                         const char *idx_name);
 
-const unsigned char *get_midx_checksum(const struct multi_pack_index *m)
+const unsigned char *midx_get_checksum_hash(const struct multi_pack_index *m)
 {
        return m->data + m->data_len - m->source->odb->repo->hash_algo->rawsz;
 }

diff --git a/midx.h b/midx.h
index 7c7e0b5912151b46455e386baa78418f20f26c4f..62d6105195f0fb05d617a8a66e999aa4f9f04c68 100644 (file)
--- a/midx.h
+++ b/midx.h
@@ -85,7 +85,7 @@ struct multi_pack_index {
 #define MIDX_EXT_BITMAP "bitmap"
 #define MIDX_EXT_MIDX "midx"
 
-const unsigned char *get_midx_checksum(const struct multi_pack_index *m);
+const unsigned char *midx_get_checksum_hash(const struct multi_pack_index *m);
 void get_midx_filename(struct odb_source *source, struct strbuf *out);
 void get_midx_filename_ext(struct odb_source *source, struct strbuf *out,
                           const unsigned char *hash, const char *ext);

diff --git a/pack-bitmap.c b/pack-bitmap.c
index 8ca79725b1d4380377fc4c0e68141c7fc1968401..90ae63e6804ca141056be87cde353b3891942d16 100644 (file)
--- a/pack-bitmap.c
+++ b/pack-bitmap.c
@@ -441,11 +441,11 @@ char *midx_bitmap_filename(struct multi_pack_index *midx)
        struct strbuf buf = STRBUF_INIT;
        if (midx->has_chain)
                get_split_midx_filename_ext(midx->source, &buf,
-                                           get_midx_checksum(midx),
+                                           midx_get_checksum_hash(midx),
                                            MIDX_EXT_BITMAP);
        else
                get_midx_filename_ext(midx->source, &buf,
-                                     get_midx_checksum(midx),
+                                     midx_get_checksum_hash(midx),
                                      MIDX_EXT_BITMAP);
 
        return strbuf_detach(&buf, NULL);
@@ -502,7 +502,7 @@ static int open_midx_bitmap_1(struct bitmap_index *bitmap_git,
        if (load_bitmap_header(bitmap_git) < 0)
                goto cleanup;
 
-       if (!hasheq(get_midx_checksum(bitmap_git->midx), bitmap_git->checksum,
+       if (!hasheq(midx_get_checksum_hash(bitmap_git->midx), bitmap_git->checksum,
                    bitmap_repo(bitmap_git)->hash_algo)) {
                error(_("checksum doesn't match in MIDX and bitmap"));
                goto cleanup;
@@ -2820,7 +2820,7 @@ void test_bitmap_walk(struct rev_info *revs)
 
                if (bitmap_is_midx(found))
                        fprintf_ln(stderr, "Located via MIDX '%s'.",
-                                  hash_to_hex_algop(get_midx_checksum(found->midx),
+                                  hash_to_hex_algop(midx_get_checksum_hash(found->midx),
                                                     revs->repo->hash_algo));
                else
                        fprintf_ln(stderr, "Located via pack '%s'.",

diff --git a/pack-revindex.c b/pack-revindex.c
index 8598b941c8c4191397094eaa852d68cdd7997d05..70731071ab6a7788363a348868bb407d47868d68 100644 (file)
--- a/pack-revindex.c
+++ b/pack-revindex.c
@@ -390,11 +390,11 @@ int load_midx_revindex(struct multi_pack_index *m)
 
        if (m->has_chain)
                get_split_midx_filename_ext(m->source, &revindex_name,
-                                           get_midx_checksum(m),
+                                           midx_get_checksum_hash(m),
                                            MIDX_EXT_REV);
        else
                get_midx_filename_ext(m->source, &revindex_name,
-                                     get_midx_checksum(m),
+                                     midx_get_checksum_hash(m),
                                      MIDX_EXT_REV);
 
        ret = load_revindex_from_disk(m->source->odb->repo->hash_algo,

diff --git a/t/helper/test-read-midx.c b/t/helper/test-read-midx.c
index 6de5d1665afbfc8a6bee29983107cd1c8e28a98b..b8fefb1a1245e21c09a2c23285a1d14f3cd5daf0 100644 (file)
--- a/t/helper/test-read-midx.c
+++ b/t/helper/test-read-midx.c
@@ -34,7 +34,7 @@ static int read_midx_file(const char *object_dir, const char *checksum,
                return 1;
 
        if (checksum) {
-               while (m && strcmp(hash_to_hex(get_midx_checksum(m)), checksum))
+               while (m && strcmp(hash_to_hex(midx_get_checksum_hash(m)), checksum))
                        m = m->base_midx;
                if (!m)
                        return 1;
@@ -94,7 +94,7 @@ static int read_midx_checksum(const char *object_dir)
        m = setup_midx(object_dir);
        if (!m)
                return 1;
-       printf("%s\n", hash_to_hex(get_midx_checksum(m)));
+       printf("%s\n", hash_to_hex(midx_get_checksum_hash(m)));
 
        close_midx(m);
        return 0;