ident: rename commit_rewrite_person() to apply_mailmap_to_header()

commit_rewrite_person() takes a commit buffer and replaces the idents in the header with their canonical versions using the mailmap mechanism. The name "commit_rewrite_person()" is misleading as it doesn't convey what kind of rewrite are we going to do to the buffer. It also doesn't clearly mention that the function will limit itself to the header part of the buffer. The new name, "apply_mailmap_to_header()", expresses the functionality of the function pretty clearly. We intend to use apply_mailmap_to_header() in git-cat-file to replace idents in the headers of commit and tag object buffers. So, we will be extending this function to take tag objects buffer as well and replace idents on the tagger header using the mailmap mechanism. Mentored-by: Christian Couder <christian.couder@gmail.com> Mentored-by: John Cai <johncai86@gmail.com> Signed-off-by: Siddharth Asthana <siddharthasthana31@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Siddharth Asthana committed Jul 19, 2022 at 01:21 UTC 66a8a95315edb3feba1190dcd89a208ae71bda61
3 files changed +6 -6
cache.h
+3 -3
@@ -1689,10 +1689,10 @@ struct ident_split {
1689 int split_ident_line(struct ident_split *, const char *, int);
1690
1691 /*
1692 - * Given a commit object buffer and the commit headers, replaces the idents
1693 - * in the headers with their canonical versions using the mailmap mechanism.
1692 + * Given a commit or tag object buffer and the commit or tag headers, replaces
1693 + * the idents in the headers with their canonical versions using the mailmap mechanism.
1694 */
1695 -void commit_rewrite_person(struct strbuf *, const char **, struct string_list *);
1695 +void apply_mailmap_to_header(struct strbuf *, const char **, struct string_list *);
1696
1697 /*
1698 * Compare split idents for equality or strict ordering. Note that we
ident.c
+2 -2
@@ -387,8 +387,8 @@ static ssize_t rewrite_ident_line(const char *person, size_t len,
387 return 0;
388 }
389
390 -void commit_rewrite_person(struct strbuf *buf, const char **header,
391 - struct string_list *mailmap)
390 +void apply_mailmap_to_header(struct strbuf *buf, const char **header,
391 + struct string_list *mailmap)
392 {
393 size_t buf_offset = 0;
394
revision.c
+1 -1
@@ -3792,7 +3792,7 @@ static int commit_match(struct commit *commit, struct rev_info *opt)
3792 if (!buf.len)
3793 strbuf_addstr(&buf, message);
3794
3795 - commit_rewrite_person(&buf, commit_headers, opt->mailmap);
3795 + apply_mailmap_to_header(&buf, commit_headers, opt->mailmap);
3796 }
3797
3798 /* Append "fake" message parts as needed */