Re: [PATCH 06/11] sequencer.c: teach append_signoff how to detect duplicate s-o-b
Brandon Casey writes:
> +/* Returns 0 for non-conforming footer
Please format it like this:
/*
* Returns 0 for ...
> + * Returns 1 for conforming footer
> + * Returns 2 when sob exists within conforming footer
> + * Returns 3 when sob exists within conforming footer as last entry
> + */
> +static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
> + int ignore_footer)
> {
> int hit = 0;
> - int i, k;
> + int i, k = 0;
This is not wrong per-se, but I do not think it is necessary ('k' is
always initialized at least to 'i' before it gets used). If we need
to do this, I'd prefer to see it done in 1/11 that cleaned up the
containing function as a preparation for this series.
> int len = sb->len - ignore_footer;
> const char *buf = sb->buf;
> + int found_sob = 0;
>
> for (i = len - 1; i > 0; i--) {
> if (hit && buf[i] == '\n')
> @@ -63,14 +70,24 @@ static int has_conforming_footer(struct strbuf *sb, int
> ignore_footer)
> i++;
>
> for (; i < len; i = k) {
> + int found_rfc2822;
> +
> for (k = i; k < len && buf[k] != '\n'; k++)
> ; /* do nothing */
> k++;
>
> - if (!(is_rfc2822_line(buf+i, k-i) ||
> - is_cherry_pick_from_line(buf+i, k-i)))
> + found_rfc2822 = is_rfc2822_line(buf+i, k-i);
Not limited to this place but please have SP around binary operators, i.e.
found_rfc2822 = is_rfc2822_line(buf + i, k - i);
> + if (found_rfc2822 && sob &&
> + !strncasecmp(buf+i, sob->buf, sob->len))
> + found_sob = k;
Are we sure we want strncasecmp() here? I *think* you are trying to
catch "signed-off-By:" and other misspellings, and even though I
know in practice we know "Brandon Casey" and "brandon casey" are the
same person, it still feels somewhat sloppy. Perhaps it is just me.
> +
> + if (!(found_rfc2822 || is_cherry_pick_from_line(buf+i, k-i)))
> return 0;
> }
> + if (found_sob == i)
> + return 3;
> + if (found_sob)
> + return 2;
> return 1;
> }
>
> @@ -291,7 +308,7 @@ static int do_recursive_merge(struct commit *base, struct
> commit *next,
> rollback_lock_file(&index_lock);
>
> if (opts->signoff)
> - append_signoff(msgbuf, 0);
> + append_signoff(msgbuf, 0, 0);
>
> if (!clean) {
> int i;
> @@ -547,7 +564,7 @@ static int do_pick_commit(struct commit *commit, struct
> replay_opts *opts)
> }
>
> if (opts->record_origin) {
> - if (!has_conforming_footer(&msgbuf, 0))
> + if (!has_conforming_footer(&msgbuf, NULL, 0))
> strbuf_addch(&msgbuf, '\n');
> strbuf_addstr(&msgbuf, cherry_picked_prefix);
> strbuf_addstr(&msgbuf,
> sha1_to_hex(commit->object.sha1));
> @@ -1074,9 +1091,10 @@ int sequencer_pick_revisions(struct replay_opts *opts)
> return pick_commits(todo_list, opts);
> }
>
> -void append_signoff(struct strbuf *msgbuf, int ignore_footer)
> +void append_signoff(struct strbuf *msgbuf, int ignore_footer, int no_dup_sob)
> {
> struct strbuf sob = STRBUF_INIT;
> + int has_footer = 0;
> int i;
>
> strbuf_addstr(&sob, sign_off_header);
> @@ -1085,10 +1103,11 @@ void append_signoff(struct strbuf *msgbuf, int
> ignore_footer)
> strbuf_addch(&sob, '\n');
> for (i = msgbuf->len - 1 - ignore_footer; i > 0 && msgbuf->buf[i - 1]
> != '\n'; i--)
> ; /* do nothing */
> - if (prefixcmp(msgbuf->buf + i, sob.buf)) {
> - if (!i || !has_conforming_footer(msgbuf, ignore_footer))
> - strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
> "\n", 1);
> - strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0, sob.buf,
> sob.len);
> - }
> + if (!i || !(has_footer =
> + has_conforming_footer(msgbuf, &sob, ignore_footer)))
> + strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0, "\n", 1);
> + if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
> + strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
> + sob.buf, sob.len);
Avoid assignment inside if () conditional. It is not immediately
obvious what value is compared against 3 in the second one, as the
above makes it appear as if has_footer is uninitialized when i is
zero.
Thanks.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
[PATCH 06/11] sequencer.c: teach append_signoff how to detect duplicate s-o-b
Teach append_signoff how to detect a duplicate s-o-b in the commit footer.
This is in preparation to unify the append_signoff implementations in
log-tree.c and sequencer.c.
Fixes test in t3511.
Signed-off-by: Brandon Casey
---
builtin/commit.c | 2 +-
sequencer.c | 43 +++
sequencer.h | 2 +-
t/t3511-cherry-pick-x.sh | 2 +-
4 files changed, 34 insertions(+), 15 deletions(-)
diff --git a/builtin/commit.c b/builtin/commit.c
index 1dd2ec5..7b9e2ac 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -700,7 +700,7 @@ static int prepare_to_commit(const char *index_file, const
char *prefix,
previous = eol;
}
- append_signoff(&sb, ignore_footer);
+ append_signoff(&sb, ignore_footer, 0);
}
if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
diff --git a/sequencer.c b/sequencer.c
index 7c0852a..3062ad4 100644
--- a/sequencer.c
+++ b/sequencer.c
@@ -42,12 +42,19 @@ static int is_cherry_pick_from_line(const char *buf, int
len)
!prefixcmp(buf, cherry_picked_prefix);
}
-static int has_conforming_footer(struct strbuf *sb, int ignore_footer)
+/* Returns 0 for non-conforming footer
+ * Returns 1 for conforming footer
+ * Returns 2 when sob exists within conforming footer
+ * Returns 3 when sob exists within conforming footer as last entry
+ */
+static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
+ int ignore_footer)
{
int hit = 0;
- int i, k;
+ int i, k = 0;
int len = sb->len - ignore_footer;
const char *buf = sb->buf;
+ int found_sob = 0;
for (i = len - 1; i > 0; i--) {
if (hit && buf[i] == '\n')
@@ -63,14 +70,24 @@ static int has_conforming_footer(struct strbuf *sb, int
ignore_footer)
i++;
for (; i < len; i = k) {
+ int found_rfc2822;
+
for (k = i; k < len && buf[k] != '\n'; k++)
; /* do nothing */
k++;
- if (!(is_rfc2822_line(buf+i, k-i) ||
- is_cherry_pick_from_line(buf+i, k-i)))
+ found_rfc2822 = is_rfc2822_line(buf+i, k-i);
+ if (found_rfc2822 && sob &&
+ !strncasecmp(buf+i, sob->buf, sob->len))
+ found_sob = k;
+
+ if (!(found_rfc2822 || is_cherry_pick_from_line(buf+i, k-i)))
return 0;
}
+ if (found_sob == i)
+ return 3;
+ if (found_sob)
+ return 2;
return 1;
}
@@ -291,7 +308,7 @@ static int do_recursive_merge(struct commit *base, struct
commit *next,
rollback_lock_file(&index_lock);
if (opts->signoff)
- append_signoff(msgbuf, 0);
+ append_signoff(msgbuf, 0, 0);
if (!clean) {
int i;
@@ -547,7 +564,7 @@ static int do_pick_commit(struct commit *commit, struct
replay_opts *opts)
}
if (opts->record_origin) {
- if (!has_conforming_footer(&msgbuf, 0))
+ if (!has_conforming_footer(&msgbuf, NULL, 0))
strbuf_addch(&msgbuf, '\n');
strbuf_addstr(&msgbuf, cherry_picked_prefix);
strbuf_addstr(&msgbuf,
sha1_to_hex(commit->object.sha1));
@@ -1074,9 +1091,10 @@ int sequencer_pick_revisions(struct replay_opts *opts)
return pick_commits(todo_list, opts);
}
-void append_signoff(struct strbuf *msgbuf, int ignore_footer)
+void append_signoff(struct strbuf *msgbuf, int ignore_footer, int no_dup_sob)
{
struct strbuf sob = STRBUF_INIT;
+ int has_footer = 0;
int i;
strbuf_addstr(&sob, sign_off_header);
@@ -1085,10 +1103,11 @@ void append_signoff(struct strbuf *msgbuf, int
ignore_footer)
strbuf_addch(&sob, '\n');
for (i = msgbuf->len - 1 - ignore_footer; i > 0 && msgbuf->buf[i - 1]
!= '\n'; i--)
; /* do nothing */
- if (prefixcmp(msgbuf->buf + i, sob.buf)) {
- if (!i || !has_conforming_footer(msgbuf, ignore_footer))
- strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
"\n", 1);
- strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0, sob.buf,
sob.len);
- }
+ if (!i || !(has_footer =
+ has_conforming_footer(msgbuf, &sob, ignore_footer)))
+ strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0, "\n", 1);
+ if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
+ strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
+ sob.buf, sob.len);
strbuf_release(&sob);
}
diff --git a/sequencer.h b/sequencer.h
index 9d57d57..c4c7132 100644
--- a/sequencer.h
+++ b/sequencer.h
@@ -48,6 +48,6 @@ int sequencer_pick_revi
