mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <>
To: Harshit Jain <>
Cc: Shourya Shukla <>,
Subject: Re: [GSoC][PATCH 1/2] t4131: modernize style
Date: Thu, 19 Mar 2020 14:55:08 -0700	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <> (Harshit Jain's message of "Thu, 19 Mar 2020 23:15:32 +0530")

Harshit Jain <> writes:

>> > The tests in '' were written a long
>> > time ago, and have a few style violations. Update it to adhere
>> > to the CodingGuidelines.
>> ...
> I used 'git commit' only and not 'git commit -m "message". But

I'd suggest developers, especially the new ones, to stay away from
using '-m "message"' form, too.

In your editor, you would probably have written something like

	-- -- -- -- -- the contents of editor window -- -- -- -- --
	t4131: modernize style

	The tests in '' were written ...

	-- -- -- -- -- the contents of editor window -- -- -- -- --

As you observed, the first paragraph of the log message text is
taken as the title of the commit, and "git format-patch" places the
title on the "Subject:" line (if you had more than one line in the
first paragraph, since the payload on the "Subject: " line has to be
a logically single line, you'd end up getting a single long line
that has the contents on all lines in the first paragraph).

The second and subsequent paragraphs become the body of the message.

Your title looks reasonable; there is nothing that needs to be
"fixed" or "improved" there.

Your second paragraph is not so good---it should wrap the lines at a
reasonable length (say 65-70 columns).

Your last paragraph, which consists of a single "Signed-off-by:"
line in this case, is good.  It matches the identity recorded on the
"From:" line of the message.

>> Also, commit messages are generally around 72 characters per line. What are the
>> style violations you are talking about BTW?
> The git coding guidelines says that we shouldn't have a space after
> the redirection operators, hence I corrected this in the test file.

That is a good thing to write in the commit log message.  

"written a long time ago" does not have much value by itself (it
does serve as a backstory to explain a half of why it does not use
the more modern style, though).  "have a few style violations." is
almost meaningless (otherwise, you would not be doing a "modernize
style" patch in the first place ;-).

	t4131: modernize style.

	The tests in t4131 leaves a SP between a redirection
	operator and the file that is the redirection target,
	which does not conform to the modern coding style.

	Fix them.

	Signed-off-by: ...


  reply	other threads:[~2020-03-19 21:55 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-19 13:29 [GSoC][Patch 0/2] t4131: update test script Harshit Jain
2020-03-19 13:29 ` [GSoC][PATCH 1/2] t4131: modernize style Harshit Jain
2020-03-19 16:38   ` Shourya Shukla
2020-03-19 17:45     ` Harshit Jain
2020-03-19 21:55       ` Junio C Hamano [this message]
2020-03-19 13:29 ` [GSoC][PATCH 2/2] t4131: use helper function to replace test -f <path> Harshit Jain
2020-03-19 16:42   ` Shourya Shukla
2020-03-19 17:33     ` Kaartic Sivaraam
2020-03-19 20:18       ` Harshit Jain
2020-03-20 15:39       ` Re: RFC][Feature] submodule Shourya Shukla
2020-03-19 21:58     ` [GSoC][PATCH 2/2] t4131: use helper function to replace test -f <path> Junio C Hamano
2020-03-20 13:08       ` [GSoC][Patch 0/2] made the changes as per community suggestions Harshit Jain
2020-03-20 13:08         ` [PATCH 1/2] t4131: modernize style Harshit Jain
2020-03-20 15:56           ` Re: [GSoC][Patch] Shourya Shukla
2020-03-20 17:14             ` Harshit Jain
2020-03-20 13:08         ` [PATCH 2/2] t4131: use helper function to replace 'test -f' Harshit Jain
2020-03-20 15:43       ` Re: [GSoC][Patch] Shourya Shukla

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:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \ \

* 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

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).