Re: [ANNOUNCE] git-series: track changes to a patch series over time

From: Simon Glass <sjg@chromium.org>
Date: Aug 15, 2016, 18:17 UTC
Message-ID: <CAPnjgZ2-sWuibLGK-AR2D=mM=MoOrQM9OVuJnCtVAE5GYqJXcQ@mail.gmail.com>
In-Reply-To: <20160801183750.ivwue4mxm5ilgzqz@x>

Hi Josh,

On 1 August 2016 at 12:37, Josh Triplett <josh@joshtriplett.org> wrote:

Show 25 quoted lines

> On Mon, Aug 01, 2016 at 09:14:54AM -0600, Stephen Warren wrote:
>> On 07/29/2016 12:40 AM, Josh Triplett wrote:
>> > I'd like to announce a project I've been working on for a while:
>> >
>> > git-series provides a tool for managing patch series with git, tracking
>> > the "history of history". git series tracks changes to the patch series
>> > over time, including rebases and other non-fast-forwarding changes. git
>> > series also tracks a cover letter for the patch series, formats the
>> > series for email, and prepares pull requests.
>>
>> Just as an FYI, I wouldn't be surprised if there's some overlap, or
>> potential for merging of tools, between this tool and the "patman" tool
>> that's part of the U-Boot source tree:
>>
>> http://git.denx.de/?p=u-boot.git;a=blob;f=tools/patman/README;h=e36857dedea1d0dbafa41732aaf9bf0988d63f38;hb=HEAD
>
> Interesting tool; thanks for the link.
>
> As far as I can tell from that documentation, patman doesn't track old
> versions of a patch series; you rebase to modify patches or change
> patman tags (embedded in commit messages), and nothing preserves the
> previous version.  And it tracks the cover letter and similar in one of
> the commit messages in the series, so previous versions of that don't
> get saved either.  If you wanted to track the history of your changes,
> you'd have to use branch names or similar.

That's right. Normally you would keep the old branch around, or tag it. Of course old branches are often based on older versions the upstream repo, so they are not that useful for diiff, etc. But the normal procedure when updating a series to a new version is:

git checkout -b wibble-v2 wibble git rebase upstream/master git commit --amend # Edit commit to add 'Series-version: 2', update cover letter etc.

Of course any change log is preserved when you move to v3, since you just add more 'Series-changes:' tags. The old version of the cover letter, and the old version of the commits can be preserved with 'git tag'.

>
> In addition, tracking metadata in commit messages only works with a
> patches-by-mail workflow where the messages get processed when
> generating patches; that doesn't work for please-pull workflows.

Can you explain what a please-pull workflow looks like, and what tags are expected?

Show 6 quoted lines

>
> patman does have quite a few interesting ideas, though.  git-series
> needs some way of handling To/Cc addresses for patches and the cover
> letter (beyond just scripts/get_maintainer.pl), and more automatic
> handling of series versioning (v2, v3, ...) and associated series
> changelogs.  Suggestions welcome.

Patman builds the cover letter change lists from the commits. The main point of patman is to automate the error-prone process of submitting a perfectly formed patch series.

In particular, patman requires no change to the normal workflow that people use with git.

>
> - Josh Triplett

Regards, Simon