git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Richard Hartmann <richih.mailinglist@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 1/6] templates: Use heredoc in pre-commit hook
Date: Sun, 14 Jul 2013 11:09:16 -0700	[thread overview]
Message-ID: <20130714180916.GB1267@google.com> (raw)
In-Reply-To: <1373818879-1698-2-git-send-email-richih.mailinglist@gmail.com>

Hi,

Richard Hartmann wrote:

> Spawning a new subprocess for every line printed is inefficient.
> Use heredoc, instead.

I think this makes sense as a code clarity, simplicity, and
internationalizability improvement, but don't like the precedent of
eliminating 'echo' for the sake of fork removal (unless we have
measurements showing it's worthwhile, which would be included here).

Maybe a simpler commit message could sidestep the issue?

	Use a heredoc instead of an "echo" for each line.

> Based on 98770971aef8d1cbc78876d9023d10aa25df0526 in original patch
> series from 2013-06-10.

Please don't include this.  The audience for the commit message
doesn't have that commit to compare to.

If you want to preserve the original date, the way to do that is
a "Date:" field at the top of the message body.

	Date: Fri, 28 Jun 2013 21:16:19 +0530

	Spawning a new subprocess for ...

[...]
> --- a/templates/hooks--pre-commit.sample
> +++ b/templates/hooks--pre-commit.sample
> @@ -31,18 +31,19 @@ if [ "$allownonascii" != "true" ] &&
>  	test $(git diff --cached --name-only --diff-filter=A -z $against |
>  	  LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
>  then
> -	echo "Error: Attempt to add a non-ascii file name."
> -	echo
> -	echo "This can cause problems if you want to work"
> -	echo "with people on other platforms."
> -	echo
> -	echo
> -	echo "If you know what you are doing you can disable this"
> -	echo "check using:"
> -	echo
> -	echo "  git config hooks.allownonascii true"
> -	echo
> +	cat <<-EOF
> +Error: Attempt to add a non-ascii file name.

Using

	cat <<\EOF

would make reading easier since the reader then doesn't have to worry
about whether the text being cat'ed is indented or uses variable
substitutions.

> -	echo "To be portable it is advisable to rename the file ..."
> +To be portable it is advisable to rename the file.

Yes, nice.

With the above nits addressed, this change looks to be going in the
right direction.  Thanks.

Hope that helps,
Jonathan

  reply	other threads:[~2013-07-14 18:09 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-06-10 18:35 [PATCH 0/4] Janitorial work on hook templates Richard Hartmann
2013-06-10 18:36 ` [PATCH 1/6] templates: Fewer subprocesses in pre-commit hook Richard Hartmann
2013-06-10 19:44   ` Junio C Hamano
2013-06-10 20:39     ` Richard Hartmann
2013-06-10 21:25   ` Jeff King
2013-06-10 18:36 ` [PATCH 2/6] templates: Reformat pre-commit hook's message Richard Hartmann
2013-06-10 19:47   ` Junio C Hamano
2013-06-10 18:36 ` [PATCH 3/6] templates: Fix spelling in pre-commit hook Richard Hartmann
2013-06-10 18:36 ` [PATCH 4/6] Documentation: Update manpage for " Richard Hartmann
2013-06-10 18:36 ` [PATCH 5/6] templates: Fix ASCII art in pre-rebase hook Richard Hartmann
2013-06-10 19:51   ` Junio C Hamano
2013-06-10 21:29   ` Jeff King
2013-06-10 18:36 ` [PATCH 6/6] template: Fix comment indentation " Richard Hartmann
2013-06-10 19:52   ` Junio C Hamano
2013-06-10 21:46     ` Richard Hartmann
2013-06-10 22:57       ` Junio C Hamano
2013-06-10 23:03         ` Richard Hartmann
2013-07-14 16:21           ` [PATCH 0/6] Update to janitorial work on hook templates Richard Hartmann
2013-07-14 16:21             ` [PATCH 1/6] templates: Use heredoc in pre-commit hook Richard Hartmann
2013-07-14 18:09               ` Jonathan Nieder [this message]
2013-07-15  3:22                 ` Junio C Hamano
2013-07-14 19:20               ` Junio C Hamano
2013-07-14 20:12                 ` Richard Hartmann
2013-07-14 20:20                   ` Jonathan Nieder
2013-07-15 16:49                   ` Junio C Hamano
2013-07-14 16:21             ` [PATCH 2/6] templates: Reformat pre-commit hook's message Richard Hartmann
2013-07-14 18:42               ` Jonathan Nieder
2013-07-14 16:21             ` [PATCH 3/6] templates: Fix spelling in pre-commit hook Richard Hartmann
2013-07-14 16:21             ` [PATCH 4/6] Documentation: Update manpage for " Richard Hartmann
2013-07-14 18:51               ` Jonathan Nieder
2013-07-15 16:54               ` Junio C Hamano
2013-07-14 16:21             ` [PATCH 5/6] templates: Fix ASCII art in pre-rebase hook Richard Hartmann
2013-07-14 18:52               ` Jonathan Nieder
2013-07-14 16:21             ` [PATCH 6/6] template: Fix comment indentation " Richard Hartmann
2013-07-14 18:53               ` Jonathan Nieder

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=20130714180916.GB1267@google.com \
    --to=jrnieder@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=richih.mailinglist@gmail.com \
    /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).