Skip to content

Commit

Permalink
sequencer.c: always separate "(cherry picked from" from commit body
Browse files Browse the repository at this point in the history 
Start treating the "(cherry picked from" line added by cherry-pick -x
the same way that the s-o-b lines are treated.  Namely, separate them
from the main commit message body with an empty line.

Introduce tests to test this functionality.

Signed-off-by: Brandon Casey <bcasey@nvidia.com>
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Brandon Casey authored and Junio C Hamano committed Feb 12, 2013
1 parent 2cdccad commit b971e04
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 63 deletions.
128 changes: 65 additions & 63 deletions sequencer.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,69 @@
const char sign_off_header[] = "Signed-off-by: ";
static const char cherry_picked_prefix[] = "(cherry picked from commit ";

static int is_rfc2822_line(const char *buf, int len)
{
int i;

for (i = 0; i < len; i++) {
int ch = buf[i];
if (ch == ':')
return 1;
if (!isalnum(ch) && ch != '-')
break;
}

return 0;
}

static int is_cherry_picked_from_line(const char *buf, int len)
{
/*
* We only care that it looks roughly like (cherry picked from ...)
*/
return len > strlen(cherry_picked_prefix) + 1 &&
!prefixcmp(buf, cherry_picked_prefix) && buf[len - 1] == ')';
}

static int has_conforming_footer(struct strbuf *sb, int ignore_footer)
{
char prev;
int i, k;
int len = sb->len - ignore_footer;
const char *buf = sb->buf;

/* footer must end with newline */
if (!len || buf[len - 1] != '\n')
return 0;

prev = '\0';
for (i = len - 1; i > 0; i--) {
char ch = buf[i];
if (prev == '\n' && ch == '\n') /* paragraph break */
break;
prev = ch;
}

/* require at least one blank line */
if (prev != '\n' || buf[i] != '\n')
return 0;

/* advance to start of last paragraph */
while (i < len - 1 && buf[i] == '\n')
i++;

for (; i < len; i = k) {
for (k = i; k < len && buf[k] != '\n'; k++)
; /* do nothing */
k++;

if (!is_rfc2822_line(buf + i, k - i - 1) &&
!is_cherry_picked_from_line(buf + i, k - i - 1))
return 0;
}
return 1;
}

static void remove_sequencer_state(void)
{
struct strbuf seq_dir = STRBUF_INIT;
Expand Down Expand Up @@ -493,6 +556,8 @@ static int do_pick_commit(struct commit *commit, struct replay_opts *opts)
}

if (opts->record_origin) {
if (!has_conforming_footer(&msgbuf, 0))
strbuf_addch(&msgbuf, '\n');
strbuf_addstr(&msgbuf, cherry_picked_prefix);
strbuf_addstr(&msgbuf, sha1_to_hex(commit->object.sha1));
strbuf_addstr(&msgbuf, ")\n");
Expand Down Expand Up @@ -1018,69 +1083,6 @@ int sequencer_pick_revisions(struct replay_opts *opts)
return pick_commits(todo_list, opts);
}

static int is_rfc2822_line(const char *buf, int len)
{
int i;

for (i = 0; i < len; i++) {
int ch = buf[i];
if (ch == ':')
return 1;
if (!isalnum(ch) && ch != '-')
break;
}

return 0;
}

static int is_cherry_picked_from_line(const char *buf, int len)
{
/*
* We only care that it looks roughly like (cherry picked from ...)
*/
return len > strlen(cherry_picked_prefix) + 1 &&
!prefixcmp(buf, cherry_picked_prefix) && buf[len - 1] == ')';
}

static int has_conforming_footer(struct strbuf *sb, int ignore_footer)
{
char prev;
int i, k;
int len = sb->len - ignore_footer;
const char *buf = sb->buf;

/* footer must end with newline */
if (!len || buf[len - 1] != '\n')
return 0;

prev = '\0';
for (i = len - 1; i > 0; i--) {
char ch = buf[i];
if (prev == '\n' && ch == '\n') /* paragraph break */
break;
prev = ch;
}

/* require at least one blank line */
if (prev != '\n' || buf[i] != '\n')
return 0;

/* advance to start of last paragraph */
while (i < len - 1 && buf[i] == '\n')
i++;

for (; i < len; i = k) {
for (k = i; k < len && buf[k] != '\n'; k++)
; /* do nothing */
k++;

if (!is_rfc2822_line(buf + i, k - i - 1) &&
!is_cherry_picked_from_line(buf + i, k - i - 1))
return 0;
}
return 1;
}

void append_signoff(struct strbuf *msgbuf, int ignore_footer)
{
struct strbuf sob = STRBUF_INIT;
Expand Down
53 changes: 53 additions & 0 deletions t/t3511-cherry-pick-x.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,19 @@ test_expect_success setup '
test_commit conflicting unrelated
'

test_expect_success 'cherry-pick -x inserts blank line after one line subject' '
pristine_detach initial &&
sha1=`git rev-parse mesg-one-line^0` &&
git cherry-pick -x mesg-one-line &&
cat <<-EOF >expect &&
$mesg_one_line
(cherry picked from commit $sha1)
EOF
git log -1 --pretty=format:%B >actual &&
test_cmp expect actual
'

test_expect_success 'cherry-pick -s inserts blank line after one line subject' '
pristine_detach initial &&
git cherry-pick -s mesg-one-line &&
Expand All @@ -81,6 +94,19 @@ test_expect_failure 'cherry-pick -s inserts blank line after non-conforming foot
test_cmp expect actual
'

test_expect_success 'cherry-pick -x inserts blank line when conforming footer not found' '
pristine_detach initial &&
sha1=`git rev-parse mesg-no-footer^0` &&
git cherry-pick -x mesg-no-footer &&
cat <<-EOF >expect &&
$mesg_no_footer
(cherry picked from commit $sha1)
EOF
git log -1 --pretty=format:%B >actual &&
test_cmp expect actual
'

test_expect_success 'cherry-pick -s inserts blank line when conforming footer not found' '
pristine_detach initial &&
git cherry-pick -s mesg-no-footer &&
Expand All @@ -93,6 +119,20 @@ test_expect_success 'cherry-pick -s inserts blank line when conforming footer no
test_cmp expect actual
'

test_expect_success 'cherry-pick -x -s inserts blank line when conforming footer not found' '
pristine_detach initial &&
sha1=`git rev-parse mesg-no-footer^0` &&
git cherry-pick -x -s mesg-no-footer &&
cat <<-EOF >expect &&
$mesg_no_footer
(cherry picked from commit $sha1)
Signed-off-by: $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>
EOF
git log -1 --pretty=format:%B >actual &&
test_cmp expect actual
'

test_expect_success 'cherry-pick -s adds sob when last sob doesnt match committer' '
pristine_detach initial &&
git cherry-pick -s mesg-with-footer &&
Expand Down Expand Up @@ -163,4 +203,17 @@ test_expect_success 'cherry-pick -s treats "(cherry picked from..." line as part
test_cmp expect actual
'

test_expect_success 'cherry-pick -x -s treats "(cherry picked from..." line as part of footer' '
pristine_detach initial &&
sha1=`git rev-parse mesg-with-cherry-footer^0` &&
git cherry-pick -x -s mesg-with-cherry-footer &&
cat <<-EOF >expect &&
$mesg_with_cherry_footer
(cherry picked from commit $sha1)
Signed-off-by: $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>
EOF
git log -1 --pretty=format:%B >actual &&
test_cmp expect actual
'

test_done

0 comments on commit b971e04

Please sign in to comment.