git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 1/4] revision: improve commit_rewrite_person()

From
Đoàn Trần Công Danh <congdanhqx@gmail.com>
Date
Jul 8, 2022, 14:50 UTC
Message-ID
<YshESKSHfpcQf/dI@danh.dev>
In-Reply-To
<20220707161554.6900-2-siddharthasthana31@gmail.com>
On 2022-07-07 21:45:51+0530, Siddharth Asthana <siddharthasthana31@gmail.com> wrote:
> The function, commit_rewrite_person(), is designed to find and replace
> an ident string in the header part, and the way it avoids a random
> occuranace of "author A U Thor <author@example.com" in the text is by
s/occuranace/occurrence/
Show 21 quoted lines
> insisting "author" to appear at the beginning of line by passing
> "\nauthor " as "what".
> 
> The implementation also doesn't make any effort to limit itself to the
> commit header by locating the blank line that appears after the header
> part and stopping the search there. Also, the interface forces the
> caller to make multiple calls if it wants to rewrite idents on multiple
> headers. It shouldn't be the case.
> 
> To support the existing caller better, update commit_rewrite_person()
> to:
> - Make a single pass in the input buffer to locate headers named
>   "author" and "committer" and replace idents on them.
> - Stop at the end of the header, ensuring that nothing in the body of
>   the commit object is modified.
> 
> The return type of the function commit_rewrite_person() has also been
> changed from int to void. This has been done because the caller of the
> function doesn't do anything with the return value of the function.
> 
> By simplyfying the interface of the commit_rewrite_person(), we also
s/simplyfying/simplifying/
Show 73 quoted lines
> intend to expose it as a public function. We will also be renaming the
> function in a future commit to a different name which clearly tells that
> the function replaces idents in the header of the commit buffer.
> 
> Mentored-by: Christian Couder <christian.couder@gmail.com>
> Mentored-by: John Cai <johncai86@gmail.com>
> Signed-off-by: Siddharth Asthana <siddharthasthana31@gmail.com>
> ---
>  revision.c | 44 ++++++++++++++++++++++++++++++++++----------
>  1 file changed, 34 insertions(+), 10 deletions(-)
> 
> diff --git a/revision.c b/revision.c
> index 211352795c..83e68c1f97 100644
> --- a/revision.c
> +++ b/revision.c
> @@ -3755,19 +3755,17 @@ int rewrite_parents(struct rev_info *revs, struct commit *commit,
>  	return 0;
>  }
>  
> -static int commit_rewrite_person(struct strbuf *buf, const char *what, struct string_list *mailmap)
> +/*
> + * Returns the difference between the new and old length of the ident line.
> + */
> +static ssize_t rewrite_ident_line(const char* person, struct strbuf *buf, struct string_list *mailmap)
>  {
> -	char *person, *endp;
> +	char *endp;
>  	size_t len, namelen, maillen;
>  	const char *name;
>  	const char *mail;
>  	struct ident_split ident;
>  
> -	person = strstr(buf->buf, what);
> -	if (!person)
> -		return 0;
> -
> -	person += strlen(what);
>  	endp = strchr(person, '\n');
>  	if (!endp)
>  		return 0;
> @@ -3784,6 +3782,7 @@ static int commit_rewrite_person(struct strbuf *buf, const char *what, struct st
>  
>  	if (map_user(mailmap, &mail, &maillen, &name, &namelen)) {
>  		struct strbuf namemail = STRBUF_INIT;
> +		size_t newlen;
>  
>  		strbuf_addf(&namemail, "%.*s <%.*s>",
>  			    (int)namelen, name, (int)maillen, mail);
> @@ -3792,14 +3791,39 @@ static int commit_rewrite_person(struct strbuf *buf, const char *what, struct st
>  			      ident.mail_end - ident.name_begin + 1,
>  			      namemail.buf, namemail.len);
>  
> +		newlen = namemail.len;
> +
>  		strbuf_release(&namemail);
>  
> -		return 1;
> +		return newlen - (ident.mail_end - ident.name_begin + 1);
>  	}
>  
>  	return 0;
>  }
>  
> +static void commit_rewrite_person(struct strbuf *buf, const char **headers, struct string_list *mailmap)
> +{
> +	size_t buf_offset = 0;
> +
> +	if (!mailmap)
> +		return;
> +
> +	for (;;) {
> +		const char *person, *line = buf->buf + buf_offset;
> +		int i, linelen = strchrnul(line, '\n') - line + 1;

Would you mind to change those lines to avoid mixed of declaration and expression. Also, I think i and linelen should be ssize_t instead. Something like:

		const char *person, *line;
		ssize_t i, linelen;
		line = buf->buf + buf_offset;
		linelen = strchrnul(line, '\n') - line + 1;
> +
> +		if (!linelen || linelen == 1)
> +			/* End of header */
> +			return;

And I think linelen will never be 0 or negative, even if linelen could be 0, I think we want "linelen != 0" for integer comparision.

Show 26 quoted lines
> +
> +		buf_offset += linelen;
> +
> +		for (i = 0; headers[i]; i++)
> +			if (skip_prefix(line, headers[i], &person))
> +				buf_offset += rewrite_ident_line(person, buf, mailmap);
> +	}
> +}
> +
>  static int commit_match(struct commit *commit, struct rev_info *opt)
>  {
>  	int retval;
> @@ -3835,8 +3859,8 @@ static int commit_match(struct commit *commit, struct rev_info *opt)
>  		if (!buf.len)
>  			strbuf_addstr(&buf, message);
>  
> -		commit_rewrite_person(&buf, "\nauthor ", opt->mailmap);
> -		commit_rewrite_person(&buf, "\ncommitter ", opt->mailmap);
> +		const char *commit_headers[] = { "author ", "committer ", NULL };
> +		commit_rewrite_person(&buf, commit_headers, opt->mailmap);
>  	}
>  
>  	/* Append "fake" message parts as needed */
> -- 
> 2.37.0.6.ga6a61a26c1.dirty
> 
-- 
Danh
Previous: Junio C HamanoNext: Siddharth Asthana
Message 23 of 68 in “Add support for mailmap in cat-file”
  1. 0/3 Add support for mailmap in cat-fileSiddharth Asthana, Jun 30, 2022
  2. 2/3 ident: rename commit_rewrite_person() to rewrite_ident_line()Siddharth Asthana, Jun 30, 2022
  3. Phillip WoodJun 30, 2022
  4. Christian CouderJun 30, 2022
  5. Junio C HamanoJun 30, 2022
  6. 1/3 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jun 30, 2022
  7. Đoàn Trần Công DanhJun 30, 2022
  8. Junio C HamanoJun 30, 2022
  9. 3/3 cat-file: add mailmap supportSiddharth Asthana, Jun 30, 2022
  10. Phillip WoodJun 30, 2022
  11. Phillip WoodJun 30, 2022
  12. Christian CouderJun 30, 2022
  13. Junio C HamanoJun 30, 2022
  14. Christian CouderJul 7, 2022
  15. Ævar Arnfjörð BjarmasonJun 30, 2022
  16. Junio C HamanoJun 30, 2022
  17. Christian CouderJul 7, 2022
  18. Junio C HamanoJun 30, 2022
  19. Junio C HamanoJun 30, 2022
  20. 0/4 Add support for mailmap in cat-fileSiddharth Asthana, Jul 7, 2022
  21. 1/4 revision: improve commit_rewrite_person()Siddharth Asthana, Jul 7, 2022
  22. Junio C HamanoJul 7, 2022
  23. Đoàn Trần Công DanhJul 8, 2022
  24. 2/4 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jul 7, 2022
  25. 3/4 ident: rename commit_rewrite_person() to apply_mailmap_to_header()Siddharth Asthana, Jul 7, 2022
  26. 4/4 cat-file: add mailmap supportSiddharth Asthana, Jul 7, 2022
  27. Junio C HamanoJul 7, 2022
  28. Johannes SchindelinJul 8, 2022
  29. Junio C HamanoJul 7, 2022
  30. Junio C HamanoJul 7, 2022
  31. 0/4 Add support for mailmap in cat-fileSiddharth Asthana, Jul 9, 2022
  32. 1/4 revision: improve commit_rewrite_person()Siddharth Asthana, Jul 9, 2022
  33. Johannes SchindelinJul 12, 2022
  34. 2/4 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jul 9, 2022
  35. 3/4 ident: rename commit_rewrite_person() to apply_mailmap_to_header()Siddharth Asthana, Jul 9, 2022
  36. 4/4 cat-file: add mailmap supportSiddharth Asthana, Jul 9, 2022
  37. Junio C HamanoJul 10, 2022
  38. Johannes SchindelinJul 12, 2022
  39. Junio C HamanoJul 12, 2022
  40. Siddharth AsthanaJul 12, 2022
  41. Junio C HamanoJul 12, 2022
  42. 0/4 Add support for mailmap in cat-fileSiddharth Asthana, Jul 12, 2022
  43. 1/4 revision: improve commit_rewrite_person()Siddharth Asthana, Jul 12, 2022
  44. Ævar Arnfjörð BjarmasonJul 13, 2022
  45. Christian CouderJul 13, 2022
  46. Junio C HamanoJul 14, 2022
  47. 2/4 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jul 12, 2022
  48. 3/4 ident: rename commit_rewrite_person() to apply_mailmap_to_header()Siddharth Asthana, Jul 12, 2022
  49. Ævar Arnfjörð BjarmasonJul 13, 2022
  50. Christian CouderJul 13, 2022
  51. 4/4 cat-file: add mailmap supportSiddharth Asthana, Jul 12, 2022
  52. 0/4 Add support for mailmap in cat-fileSiddharth Asthana, Jul 16, 2022
  53. 1/4 revision: improve commit_rewrite_person()Siddharth Asthana, Jul 16, 2022
  54. Junio C HamanoJul 17, 2022
  55. 2/4 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jul 16, 2022
  56. 3/4 ident: rename commit_rewrite_person() to apply_mailmap_to_header()Siddharth Asthana, Jul 16, 2022
  57. 4/4 cat-file: add mailmap supportSiddharth Asthana, Jul 16, 2022
  58. 0/4 Add support for mailmap in cat-fileSiddharth Asthana, Jul 18, 2022
  59. 1/4 revision: improve commit_rewrite_person()Siddharth Asthana, Jul 18, 2022
  60. 2/4 ident: move commit_rewrite_person() to ident.cSiddharth Asthana, Jul 18, 2022
  61. 3/4 ident: rename commit_rewrite_person() to apply_mailmap_to_header()Siddharth Asthana, Jul 18, 2022
  62. 4/4 cat-file: add mailmap supportSiddharth Asthana, Jul 18, 2022
  63. Junio C HamanoJul 25, 2022
  64. Christian CouderJul 28, 2022
  65. Junio C HamanoJul 28, 2022
  66. Siddharth AsthanaJul 30, 2022
  67. Đoàn Trần Công DanhJul 9, 2022
  68. Christian CouderJul 9, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.