public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Matthieu Moy <Matthieu.Moy@grenoble-inp•fr>
To: Eric Sunshine <sunshine@sunshineco•com>
Cc: "Louis Stuber" <stuberl@ensimag•grenoble-inp.fr>,
	"Git List" <git@vger•kernel.org>,
	"Galan Rémi" <remi.galan-alfonso@ensimag•grenoble-inp.fr>,
	"Remi Lespinet" <remi.lespinet@ensimag•grenoble-inp.fr>,
	"Guillaume Pages" <guillaume.pages@ensimag•grenoble-inp.fr>,
	"Antoine Delaite" <antoine.delaite@ensimag•grenoble-inp.fr>,
	j_franck7@msn•com, valentinduperray@gmail•com,
	thomasxnguy@gmail•com, lucienkong@hotmail•com,
	"Christian Couder" <chriscool@tuxfamily•org>
Subject: Re: [PATCH 1/2] git-bisect.sh : create a file if the bisection is in old/new mode, named "BISECT_OLDNEWMODE", so it can easily be seen outside the program without having to read BISECT_TERMS. This will have to be changed in further versions if new terms are introduced.
Date: Mon, 08 Jun 2015 13:48:32 +0200	[thread overview]
Message-ID: <vpq616yctf3.fsf@anie.imag.fr> (raw)
In-Reply-To: <CAPig+cQnrKEx_=WHw5gjA9SVtDObXWOJ3augZbhvNUuD8o19aA@mail.gmail.com> (Eric Sunshine's message of "Fri, 5 Jun 2015 16:03:15 -0400")

Eric Sunshine <sunshine@sunshineco•com> writes:

> On Fri, Jun 5, 2015 at 12:34 PM, Louis Stuber
> <stuberl@ensimag•grenoble-inp.fr> wrote:
>> git-bisect.sh :

No space before : in english.

>> create a file if the bisection is in old/new mode, named
>> "BISECT_OLDNEWMODE", so it can easily be seen outside the program
>> without having to read BISECT_TERMS. This will have to be changed in
>> further versions if new terms are introduced.
>
> Documentation/SubmittingPatches contains instructions for how to write
> a good commit message.

For french-speaking people, and Ensimag students in particular, I'd add

  http://ensiwiki.ensimag.fr/index.php/%C3%89crire_de_bons_messages_de_commit_avec_Git

> Also, wrap the commit message to 70-72 columns.

As much as possible, the summary line should even be shorter (so that
"git log --oneline" fits on a 80-chars terminal).

> This commit message doesn't do a very good job of explaining the
> problem this change is trying to solve or justifying why this solution
> is preferable.

Actually, the commit message explains one reason why this is not a good
solution: the idea of having $GIT_DIR/BISECT_TERMS was to keep the
solution generic.

Had the initial codebase been better factored, this patch series would
have been really trivial, but we hardcoded "good" and "bad" in many
places, and now changing it is hard. Introducing BISECT_TERMS is a step
forward, it avoids hardcoding the terms here and there in the code.
To me, introducing BISECT_OLDNEWMODE is a step backward, it's one more
place where we hardcode the terms.

> Justification is particularly important considering the
> ominous-sounding final sentence of the commit message (which itself
> seems to imply that this is not a very good change).

Ah, indeed, we're saying the same thing.

>> -                               echo "old" >>"$GIT_DIR/BISECT_TERMS"
>> +                               echo "old" >>"$GIT_DIR/BISECT_TERMS" &&
>> +                               echo "" > "$GIT_DIR/BISECT_OLDNEWMODE"

No space after > (noted by Eric elsewhere)

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/

  reply	other threads:[~2015-06-08 11:48 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-06-05 16:34 [PATCH 1/2] git-bisect.sh : create a file if the bisection is in old/new mode, named "BISECT_OLDNEWMODE", so it can easily be seen outside the program without having to read BISECT_TERMS. This will have to be changed in further versions if new terms are introduced Louis Stuber
2015-06-05 16:34 ` [PATCH 2/2] Fix git rev-list --bisect and git bisect visualize when the bisection is done in old/new mode Louis Stuber
2015-06-05 20:24   ` Eric Sunshine
2015-06-05 20:03 ` [PATCH 1/2] git-bisect.sh : create a file if the bisection is in old/new mode, named "BISECT_OLDNEWMODE", so it can easily be seen outside the program without having to read BISECT_TERMS. This will have to be changed in further versions if new terms are introduced Eric Sunshine
2015-06-08 11:48   ` Matthieu Moy [this message]
2015-06-05 20:24 ` Christian Couder
     [not found]   ` <1179544255.257552.1433703835857.JavaMail.zimbra@ensimag.grenoble-inp.fr>
2015-06-07 19:06     ` Louis-Alexandre Stuber
2015-06-08 11:54     ` Matthieu Moy

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

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

  git send-email \
    --in-reply-to=vpq616yctf3.fsf@anie.imag.fr \
    --to=matthieu.moy@grenoble-inp$(echo .)fr \
    --cc=antoine.delaite@ensimag$(echo .)grenoble-inp.fr \
    --cc=chriscool@tuxfamily$(echo .)org \
    --cc=git@vger$(echo .)kernel.org \
    --cc=guillaume.pages@ensimag$(echo .)grenoble-inp.fr \
    --cc=j_franck7@msn$(echo .)com \
    --cc=lucienkong@hotmail$(echo .)com \
    --cc=remi.galan-alfonso@ensimag$(echo .)grenoble-inp.fr \
    --cc=remi.lespinet@ensimag$(echo .)grenoble-inp.fr \
    --cc=stuberl@ensimag$(echo .)grenoble-inp.fr \
    --cc=sunshine@sunshineco$(echo .)com \
    --cc=thomasxnguy@gmail$(echo .)com \
    --cc=valentinduperray@gmail$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox