From: Phillip Wood <phillip.wood123@gmail.com>
To: Charvi Mendiratta <charvi077@gmail.com>, Taylor Blau <me@ttaylorr.com>
Cc: git <git@vger.kernel.org>,
Christian Couder <christian.couder@gmail.com>,
Phillip Wood <phillip.wood@dunelm.org.uk>,
Johannes.Schindelin@gmx.de
Subject: Re: [RFC PATCH 3/9] rebase -i: comment out squash!/fixup! subjects from squash message
Date: Thu, 14 Jan 2021 10:29:31 +0000 [thread overview]
Message-ID: <abc9334d-a9ec-a041-aa04-16cb4f01372a@gmail.com> (raw)
In-Reply-To: <CAPSFM5fuT0QAK9wJ_HuH3t=qThPx7Opwy0GrYieVntJ8A4ARMA@mail.gmail.com>
Hi Charvi and Taylor
On 14/01/2021 08:27, Charvi Mendiratta wrote:
> On Thu, 14 Jan 2021 at 00:31, Taylor Blau <me@ttaylorr.com> wrote:
>>
>> On Fri, Jan 08, 2021 at 02:53:41PM +0530, Charvi Mendiratta wrote:
>>> From: Phillip Wood <phillip.wood@dunelm.org.uk>
>>>
>>> When squashing commit messages the squash!/fixup! subjects are not of
>>> interest so comment them out to stop them becoming part of the final
>>> message.
>>>
>>> This change breaks a bunch of --autosquash tests which rely on the
>>> "squash! <subject>" line appearing in the final commit message. This is
>>> addressed by adding a second line to the commit message of the "squash!
>>> ..." commits and testing for that.
>>>
>>> Signed-off-by: Phillip Wood <phillip.wood@dunelm.org.uk>
>>> Signed-off-by: Charvi Mendiratta <charvi077@gmail.com>
>>> ---
>>> sequencer.c | 25 ++++++++++++++++++++++++-
>>> t/t3415-rebase-autosquash.sh | 27 +++++++++++++--------------
>>> t/t3900-i18n-commit.sh | 4 ----
>>> 3 files changed, 37 insertions(+), 19 deletions(-)
>>>
>>> diff --git a/sequencer.c b/sequencer.c
>>> index 5062976d10..b050a9a212 100644
>>> --- a/sequencer.c
>>> +++ b/sequencer.c
>>> @@ -1718,15 +1718,38 @@ static int is_pick_or_similar(enum todo_command command)
>>> }
>>> }
>>>
>>> +static size_t subject_length(const char *body)
>>> +{
>>> + size_t i, len = 0;
>>> + char c;
>>> + int blank_line = 1;
>>> + for (i = 0, c = body[i]; c; c = body[++i]) {
>>> + if (c == '\n') {
>>> + if (blank_line)
>>> + return len;
>>> + len = i + 1;
>>> + blank_line = 1;
>>> + } else if (!isspace(c)) {
>>> + blank_line = 0;
>>> + }
>>> + }
>>> + return blank_line ? len : i;
>>> +}
>>> +
>>
>> OK, so this gets the length of the subject in "body", which is defined
>> as the run of characters before a newline and then a space character.
The length of the subject is the run of characters before a line
containing only whitespace, "hello\n there" would return 13 "hello\n
\nthere" would return 5. Looking again at my code there must be a way of
writing that function that is easier to follow.
>> So
>> "foo bar\n\nbaz" would return 7, but "foo bar\nbaz" would return 11.
>>
>> Makes sense. (Apologies for stating the obvious here, I just had to read
>> this function to myself a couple of times to make sure that I understood
>> what it was doing.)
>>
>
> Earlier while testing patch, I also went through in the same way and
> now got confirmed as you described here.
>
>>> static void append_squash_message(struct strbuf *buf, const char *body,
>>> struct replay_opts *opts)
>>> {
>>> + size_t commented_len = 0;
>>> +
>>> unlink(rebase_path_fixup_msg());
>>> + if (starts_with(body, "squash!") || starts_with(body, "fixup!"))
>>> + commented_len = subject_length(body);
>>> strbuf_addf(buf, "\n%c ", comment_line_char);
>>> strbuf_addf(buf, _("This is the commit message #%d:"),
>>> ++opts->current_fixup_count + 1);
>>> strbuf_addstr(buf, "\n\n");
>>> - strbuf_addstr(buf, body);
>>> + strbuf_add_commented_lines(buf, body, commented_len);
>>> + strbuf_addstr(buf, body + commented_len);
>>
>> Very nice; the subject gets commented when it starts with "squash!" or
>> "fixup!", but the body remains uncommented. Makes sense to me.
>>
>
> I agree and Thanks to Phillip, for the patch.
>
>>> @@ -224,7 +223,7 @@ test_expect_success 'auto squash that matches longer sha1' '
>>> git cat-file blob HEAD^:file1 >actual &&
>>> test_cmp expect actual &&
>>> git cat-file commit HEAD^ >commit &&
>>> - grep squash commit >actual &&
>>> + grep "extra para" commit >actual &&
>>> test_line_count = 1 actual
>>> '
>>
>> Worth checking that "squash" doesn't appear in an uncommented part of
>> actual? Or better yet, checking that "# squash ..." _does_ appear.
>>
>> I.e., that we would leave this as:
>>
>> - grep squash commit >actual &&
>> + grep "^# squash" commit >actual &&
>> + grep "extra para" commit >actual &&
This test is checking the message that gets committed, not the contents
of the file passed to the editor. I like the idea of checking that the
squash! line is indeed commented out, but we'd need to test it with
grep -v squash
Looking at the changes to the tests in this commit it highlights the
fact that I don't think we ever check exactly what the user sees in
their editor. We do add such a test for the new `fixup -C` functionality
in a later patch but perhaps we should improve the test coverage of the
squash message presented to the user before then.
Best Wishes
Phillip
>>> @@ -342,8 +341,8 @@ test_expect_success C_LOCALE_OUTPUT 'autosquash with custom inst format' '
>>> git cat-file blob HEAD^:file1 >actual &&
>>> test_cmp expect actual &&
>>> git cat-file commit HEAD^ >commit &&
>>> - grep squash commit >actual &&
>>> - test_line_count = 2 actual
>>> + grep first commit >actual &&
>>> + test_line_count = 3 actual
>>> '
>>
>> Ditto.
>
> Okay, I will add it .
>
> Thanks and Regards,
> Charvi
>
>>
>> Thanks,
>> Taylor
next prev parent reply other threads:[~2021-01-14 10:32 UTC|newest]
Thread overview: 110+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-08 9:23 [RFC PATCH 0/9][Outreachy] rebase -i: add options to fixup command Charvi Mendiratta
2021-01-08 9:23 ` [RFC PATCH 1/9] rebase -i: only write fixup-message when it's needed Charvi Mendiratta
2021-01-13 18:43 ` Taylor Blau
2021-01-14 8:12 ` Charvi Mendiratta
2021-01-14 10:46 ` Phillip Wood
2021-01-15 8:38 ` Charvi Mendiratta
2021-01-15 17:22 ` Junio C Hamano
2021-01-16 4:49 ` Charvi Mendiratta
2021-01-08 9:23 ` [RFC PATCH 2/9] sequencer: factor out code to append squash message Charvi Mendiratta
2021-01-08 9:23 ` [RFC PATCH 3/9] rebase -i: comment out squash!/fixup! subjects from " Charvi Mendiratta
2021-01-13 19:01 ` Taylor Blau
2021-01-14 8:27 ` Charvi Mendiratta
2021-01-14 10:29 ` Phillip Wood [this message]
2021-01-15 8:35 ` Charvi Mendiratta
2021-01-15 8:44 ` Christian Couder
2021-01-15 11:12 ` Charvi Mendiratta
2021-01-17 3:39 ` Charvi Mendiratta
2021-01-18 18:29 ` Phillip Wood
2021-01-19 4:08 ` Charvi Mendiratta
2021-01-08 9:23 ` [RFC PATCH 4/9] sequencer: pass todo_item to do_pick_commit() Charvi Mendiratta
2021-01-08 9:23 ` [RFC PATCH 5/9] sequencer: use const variable for commit message comments Charvi Mendiratta
2021-01-13 19:14 ` Taylor Blau
2021-01-13 20:37 ` Junio C Hamano
2021-01-14 7:40 ` Christian Couder
2021-01-14 8:57 ` Charvi Mendiratta
2021-01-08 9:23 ` [RFC PATCH 6/9] rebase -i: add fixup [-C | -c] command Charvi Mendiratta
2021-01-14 9:23 ` Christian Couder
2021-01-14 9:45 ` Charvi Mendiratta
2021-01-08 9:23 ` [RFC PATCH 7/9] t3437: test script for fixup [-C|-c] options in interactive rebase Charvi Mendiratta
2021-01-08 9:23 ` [RFC PATCH 8/9] rebase -i: teach --autosquash to work with amend! Charvi Mendiratta
2021-01-08 9:23 ` [RFC PATCH 9/9] doc/git-rebase: add documentation for fixup [-C|-c] options Charvi Mendiratta
2021-01-19 7:40 ` [PATCH v2 0/9][Outreachy] rebase -i: add options to fixup command Charvi Mendiratta
2021-01-24 17:03 ` [PATCH v3 " Charvi Mendiratta
2021-01-24 17:03 ` [PATCH v3 1/9] rebase -i: only write fixup-message when it's needed Charvi Mendiratta
2021-01-24 17:04 ` [PATCH v3 2/9] sequencer: factor out code to append squash message Charvi Mendiratta
2021-01-24 17:04 ` [PATCH v3 3/9] rebase -i: comment out squash!/fixup! subjects from " Charvi Mendiratta
2021-01-24 17:04 ` [PATCH v3 4/9] sequencer: pass todo_item to do_pick_commit() Charvi Mendiratta
2021-01-24 17:04 ` [PATCH v3 5/9] sequencer: use const variable for commit message comments Charvi Mendiratta
2021-01-24 17:04 ` [PATCH v3 6/9] rebase -i: add fixup [-C | -c] command Charvi Mendiratta
2021-01-24 17:04 ` [PATCH v3 7/9] t3437: test script for fixup [-C|-c] options in interactive rebase Charvi Mendiratta
2021-01-24 17:04 ` [PATCH v3 8/9] rebase -i: teach --autosquash to work with amend! Charvi Mendiratta
2021-01-24 17:04 ` [PATCH v3 9/9] doc/git-rebase: add documentation for fixup [-C|-c] options Charvi Mendiratta
2021-01-29 18:20 ` [PATCH v4 0/9][Outreachy] rebase -i: add options to fixup command Charvi Mendiratta
2021-01-29 18:20 ` [PATCH v4 1/9] rebase -i: only write fixup-message when it's needed Charvi Mendiratta
2021-01-29 18:20 ` [PATCH v4 2/9] sequencer: factor out code to append squash message Charvi Mendiratta
2021-01-29 18:20 ` [PATCH v4 3/9] rebase -i: comment out squash!/fixup! subjects from " Charvi Mendiratta
2021-01-29 18:20 ` [PATCH v4 4/9] sequencer: pass todo_item to do_pick_commit() Charvi Mendiratta
2021-01-29 18:20 ` [PATCH v4 5/9] sequencer: use const variable for commit message comments Charvi Mendiratta
2021-01-29 18:20 ` [PATCH v4 6/9] rebase -i: add fixup [-C | -c] command Charvi Mendiratta
2021-02-02 0:47 ` Eric Sunshine
2021-02-02 15:29 ` Charvi Mendiratta
2021-02-03 5:05 ` Eric Sunshine
2021-02-04 0:00 ` Charvi Mendiratta
2021-02-04 0:14 ` Eric Sunshine
2021-01-29 18:20 ` [PATCH v4 7/9] t3437: test script for fixup [-C|-c] options in interactive rebase Charvi Mendiratta
2021-02-02 2:01 ` Eric Sunshine
2021-02-02 10:02 ` Christian Couder
2021-02-02 15:31 ` Charvi Mendiratta
2021-02-03 5:44 ` Eric Sunshine
2021-02-04 0:01 ` Charvi Mendiratta
2021-02-04 10:46 ` Phillip Wood
2021-02-04 16:14 ` Eric Sunshine
2021-02-04 19:12 ` Charvi Mendiratta
2021-01-29 18:20 ` [PATCH v4 8/9] rebase -i: teach --autosquash to work with amend! Charvi Mendiratta
2021-02-02 3:20 ` Eric Sunshine
2021-02-02 15:29 ` Charvi Mendiratta
2021-01-29 18:20 ` [PATCH v4 9/9] doc/git-rebase: add documentation for fixup [-C|-c] options Charvi Mendiratta
2021-02-02 3:23 ` Eric Sunshine
2021-02-02 14:12 ` Marc Branchaud
2021-02-02 15:30 ` Charvi Mendiratta
2021-02-04 19:04 ` [PATCH v5 0/8][Outreachy] rebase -i: add options to fixup command Charvi Mendiratta
2021-02-04 19:05 ` [PATCH v5 1/8] rebase -i: only write fixup-message when it's needed Charvi Mendiratta
2021-02-04 19:05 ` [PATCH v5 2/8] sequencer: factor out code to append squash message Charvi Mendiratta
2021-02-04 19:05 ` [PATCH v5 3/8] rebase -i: comment out squash!/fixup! subjects from " Charvi Mendiratta
2021-02-04 19:05 ` [PATCH v5 4/8] sequencer: pass todo_item to do_pick_commit() Charvi Mendiratta
2021-02-04 19:05 ` [PATCH v5 5/8] sequencer: use const variable for commit message comments Charvi Mendiratta
2021-02-04 19:05 ` [PATCH v5 6/8] rebase -i: add fixup [-C | -c] command Charvi Mendiratta
2021-02-04 19:05 ` [PATCH v5 7/8] t3437: test script for fixup [-C|-c] options in interactive rebase Charvi Mendiratta
2021-02-04 19:05 ` [PATCH v5 8/8] doc/git-rebase: add documentation for fixup [-C|-c] options Charvi Mendiratta
2021-02-05 7:30 ` [PATCH v5 0/8][Outreachy] rebase -i: add options to fixup command Eric Sunshine
2021-02-05 9:42 ` Charvi Mendiratta
2021-02-05 18:25 ` Christian Couder
2021-02-05 18:56 ` Eric Sunshine
2021-02-06 5:36 ` Charvi Mendiratta
2021-02-05 19:13 ` Junio C Hamano
2021-02-06 5:37 ` Charvi Mendiratta
2021-01-19 7:40 ` [PATCH v2 1/9] rebase -i: only write fixup-message when it's needed Charvi Mendiratta
2021-01-19 7:40 ` [PATCH v2 2/9] sequencer: factor out code to append squash message Charvi Mendiratta
2021-01-19 7:40 ` [PATCH v2 3/9] rebase -i: comment out squash!/fixup! subjects from " Charvi Mendiratta
2021-01-21 1:38 ` Junio C Hamano
2021-01-21 14:02 ` Charvi Mendiratta
2021-01-21 15:21 ` Christian Couder
2021-01-21 16:58 ` Phillip Wood
2021-01-21 20:56 ` Junio C Hamano
2021-01-22 19:41 ` Charvi Mendiratta
2021-01-22 19:41 ` Charvi Mendiratta
2021-01-19 7:40 ` [PATCH v2 4/9] sequencer: pass todo_item to do_pick_commit() Charvi Mendiratta
2021-01-19 7:41 ` [PATCH v2 5/9] sequencer: use const variable for commit message comments Charvi Mendiratta
2021-01-19 7:41 ` [PATCH v2 6/9] rebase -i: add fixup [-C | -c] command Charvi Mendiratta
2021-01-19 7:41 ` [PATCH v2 7/9] t3437: test script for fixup [-C|-c] options in interactive rebase Charvi Mendiratta
2021-01-19 7:41 ` [PATCH v2 8/9] rebase -i: teach --autosquash to work with amend! Charvi Mendiratta
2021-01-19 7:41 ` [PATCH v2 9/9] doc/git-rebase: add documentation for fixup [-C|-c] options Charvi Mendiratta
2021-01-19 14:37 ` Marc Branchaud
2021-01-19 17:13 ` Charvi Mendiratta
2021-01-19 22:05 ` Marc Branchaud
2021-01-20 7:10 ` Charvi Mendiratta
2021-01-20 11:04 ` Phillip Wood
2021-01-20 12:31 ` Charvi Mendiratta
2021-01-20 14:29 ` Phillip Wood
2021-01-20 16:09 ` Charvi Mendiratta
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=abc9334d-a9ec-a041-aa04-16cb4f01372a@gmail.com \
--to=phillip.wood123@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=charvi077@gmail.com \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=me@ttaylorr.com \
--cc=phillip.wood@dunelm.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).