Re: [GSoC][RFC/PATCH 1/1] userdiff - support shell script

From: Thomas Gummerer <t.gummerer@gmail.com>
Date: Mar 16, 2019, 18:45 UTC
Message-ID: <20190316184516.GL16414@hank.intra.tgummerer.com>
In-Reply-To: <CAMknYEP3dp0a9B4ZW5F8kt+rrRZagWaVYBMhYRWj68UgYrF-GA@mail.gmail.com>

[please keep everyone in Cc, especially the mailing list if you are responding to review comments. I added the Cc's back]

On 03/16, Kapil Jain wrote:

Show 21 quoted lines

> On Sat, Mar 16, 2019 at 4:35 AM Thomas Gummerer <t.gummerer@gmail.com> wrote:
> >
> > For testing you could have a look how other userdiff drivers are
> > tested in t4034.  The easiest way is probably to have a look at a
> > patch for a userdiff pattern that was added previously.  For example
> > have a look at 0719f3eecd ("userdiff: add built-in pattern for CSS",
> > 2016-06-03).  (I found this commit by looking at the git blame output
> > for t4034.)
> > *1*: https://public-inbox.org/git/20170329165331.17742-1-pickfire@riseup.net/#t
> 
> Thanks, this helped in understanding testing process.
> 
> > Both the two lines above and the line below should go below the ---
> > line, as they should not be part of the history in the git project,
> > but serve only as additional commentary for reviewers looking at this
> > patch.
> 
> I looked at other patches like
> (https://public-inbox.org/git/CAC05386q2iGoiJ_fRgwoOTF23exEN2D1+oh4VjajEvYQ58O1TQ@mail.gmail.com/)
> The patch has the email body above --- line. did i missed to
> understanding something here ?

Right, what I was trying but failed to explain is that everything above the --- line is part of the commit message, that gets recorded in the history of the project.

However the lines I referred to, should not go in the commit message, as they are just commentary that helps reviewers, but don't actually explain the patch itself. That additional commentary should go below the --- line, similar to the

    Notes:
        Travis CI results: https://travis-ci.org/nbelakovski/git/builds/432320949

lines in the email you mentioned.