Changelog upload together with patches

[Michael Nazzareno Trimarchi]

Hi all

Is there a way to upload my patches together with the changelog
description outside the patch itself?

Michael

[Michael Nazzareno Trimarchi]

Hi

Just a plus that I forget, it's in Gerrit. Nice to have revision history bu could be nice to see out of commit comment

Michael 

[Martin Fick]

On Sat, 2 Sept 2023 at 03:57, Michael Nazzareno Trimarchi <mic...@amarulasolutions.com> wrote:

Is there a way to upload my patches together with the changelog
description outside the patch itself?

 

It's not clear to me what you mean by changelog, and what you would like to do with that changelog? Can you elaborate more on what you are trying to achieve?

-Martin

[Michael Nazzareno Trimarchi]

Hi

Commit message header

Description.....

----

Change v3->v4

Some info. This sometime happen when someone propose a new version using mailing list and this paper is not applied by git

---

Change code 

git push origin HEAD:refs/for/master

Now the code get in to Gerrit and nice to have changelog in the the upload

This way the code land with some info more for reviewer

Michael

-Martin

[Nasser Grainawi]

Yeah, this style is common when sending a patch series to a mailing list and has been discussed as something missing from Gerrit, but no one has implemented a solution. I could imagine a solution maybe using git notes and putting the note on the first commit in your series (I think that would match the mailing list experience best) and then somehow Gerrit could show you this note, but I don't know if that would work well in practice.

Nasser

 

Michael

-Martin

--
--
To unsubscribe, email repo-discuss...@googlegroups.com
More info at http://groups.google.com/group/repo-discuss?hl=en

---
You received this message because you are subscribed to the Google Groups "Repo and Gerrit Discussion" group.
To unsubscribe from this group and stop receiving emails from it, send an email to repo-discuss...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/repo-discuss/CAOf5uwmDxG%2Bob-aoSptOzyDj%3Da8A%3Dwk2rP3C_EGrzkge_9ZrWw%40mail.gmail.com.

[Sven Selberg]

On Thursday, September 7, 2023 at 7:03:07 AM UTC+2 Nasser Grainawi wrote:

On Sun, Sep 3, 2023 at 1:02 PM Michael Nazzareno Trimarchi <mic...@amarulasolutions.com> wrote:

Hi

Il dom 3 set 2023, 19:54 Martin Fick <marti...@linaro.org> ha scritto:

On Sat, 2 Sept 2023 at 03:57, Michael Nazzareno Trimarchi <mic...@amarulasolutions.com> wrote:

Is there a way to upload my patches together with the changelog
description outside the patch itself?

 

It's not clear to me what you mean by changelog, and what you would like to do with that changelog? Can you elaborate more on what you are trying to achieve?

Commit message header

Description.....

----

Change v3->v4

Some info. This sometime happen when someone propose a new version using mailing list and this paper is not applied by git

---

Change code 

git push origin HEAD:refs/for/master

Now the code get in to Gerrit and nice to have changelog in the the upload

This way the code land with some info more for reviewer

Yeah, this style is common when sending a patch series to a mailing list and has been discussed as something missing from Gerrit, but no one has implemented a solution. I could imagine a solution maybe using git notes and putting the note on the first commit in your series (I think that would match the mailing list experience best) and then somehow Gerrit could show you this note, but I don't know if that would work well in practice.

As an adjacent note: Gitiles displays git-notes.

[Martin Fick]

On Wed, 6 Sept 2023 at 23:03, Nasser Grainawi <nasser....@linaro.org> wrote:

On Sun, Sep 3, 2023 at 1:02 PM Michael Nazzareno Trimarchi <mic...@amarulasolutions.com> wrote:

Il dom 3 set 2023, 19:54 Martin Fick <marti...@linaro.org> ha scritto:

On Sat, 2 Sept 2023 at 03:57, Michael Nazzareno Trimarchi <mic...@amarulasolutions.com> wrote:

Is there a way to upload my patches together with the changelog
description outside the patch itself?

 

It's not clear to me what you mean by changelog, and what you would like to do with that changelog? Can you elaborate more on what you are trying to achieve?

Commit message header

Description.....

----

Change v3->v4

Some info. This sometime happen when someone propose a new version using mailing list and this paper is not applied by git

---

Change code 

git push origin HEAD:refs/for/master

Now the code get in to Gerrit and nice to have changelog in the the upload

This way the code land with some info more for reviewer

> Yeah, this style is common when sending a patch series to a mailing list and has been discussed as something missing from Gerrit, but no one has implemented a solution. I could imagine a solution maybe using git notes and putting the note on the first commit in your series (I think that would match the mailing list experience best) and then somehow Gerrit could show you this note, but I don't know if that would work well in practice.

I believe this is actually called a "cover letter" on most mailing lists. I would suggest cross posting this on the git mailing list to see if they can help come up with a git notes convention for this. For example, perhaps they can establish a special notes refnamespace for coverletters (refs/notes/coverletter)? Then perhaps Gerrit could have a way to display it directly with a change series, almost as if the cover letter were "before" the first change in the series? Perhaps in the relation chain? Perhaps as another Tab next to "Files" and "Checks"?

-Martin

[Kenyon Ralph]

I tend to add a comment to one of my changes when there is some additional explanation needed that doesn't really fit in a commit message or issue tracker.

[Oswald Buddenhagen]

On Thu, Sep 07, 2023 at 09:29:33AM -0600, Martin Fick wrote:
>On Sun, Sep 3, 2023 at 1:02 PM Michael Nazzareno Trimarchi <mic...@amarulasolutions.com> wrote:
>> Commit message header
>>
>> Description.....
>>
>> ----
>> Change v3->v4
>> Some info. This sometime happen when someone propose a new version using
>> mailing list and this paper is not applied by git
>> ---
>> Change code
>>
>>
>> git push origin HEAD:refs/for/master
>>
>>
>> Now the code get in to Gerrit and nice to have changelog in the the upload
>>
>> This way the code land with some info more for reviewer
>>
>

>I believe this is actually called a "cover letter" on most mailing
>lists.
>

no, it's not.
the cover letter concept is explained in git-send-email(1).
(*)

what michael is talking about is essentially a commit message on the
inter-diff between patchsets.

git-am strips everything after the first separator line, so one can just
include this "meta-meta" info without it ending up in the commit
history. gerrit could easily replicate this behavior in cherry-pick
mode.

i somewhat question the usefulness of this, though.

firstly, inter-diff display is a rather essential and easily accessible
feature in gerrit, so there is usually little use in wasting words on
summarizing the changes.

secondly, when really necessary, one can simply post a comment after
pushing the new patchset.

(*) side notes:
- when a cover letter is included, it's conventional for it to contain a
changelog as well. but that doesn't preclude each commit from having
its own, too.
- git-send-email --range-diff will generate something akin to gerrit's
inter-diffs. but as this feature can document commit additions and
deletions, it exists on a series level, and therefore the output ends
up in a cover letter.
but i noticed that people don't use this as a replacement for manual
changelogs, only an addition. i guess this makes sense, as the purely
textual range-diff is still a lot harder to read than gerrit's
inter-diff.

regards

[Michael Nazzareno Trimarchi]

Hi

On Mon, Sep 11, 2023 at 11:35 AM Oswald Buddenhagen
<oswald.bu...@gmx.de> wrote:
>
> On Thu, Sep 07, 2023 at 09:29:33AM -0600, Martin Fick wrote:
> >On Sun, Sep 3, 2023 at 1:02 PM Michael Nazzareno Trimarchi <mic...@amarulasolutions.com> wrote:
> >> Commit message header
> >>
> >> Description.....
> >>
> >> ----
> >> Change v3->v4
> >> Some info. This sometime happen when someone propose a new version using
> >> mailing list and this paper is not applied by git
> >> ---
> >> Change code
> >>
> >>
> >> git push origin HEAD:refs/for/master
> >>
> >>
> >> Now the code get in to Gerrit and nice to have changelog in the the upload
> >>
> >> This way the code land with some info more for reviewer
> >>
> >
> >I believe this is actually called a "cover letter" on most mailing
> >lists.
> >
> no, it's not.
> the cover letter concept is explained in git-send-email(1).
> (*)
>
> what michael is talking about is essentially a commit message on the
> inter-diff between patchsets.
>

Exactly

> git-am strips everything after the first separator line, so one can just
> include this "meta-meta" info without it ending up in the commit
> history. gerrit could easily replicate this behavior in cherry-pick
> mode.
>
> i somewhat question the usefulness of this, though.
>
> firstly, inter-diff display is a rather essential and easily accessible
> feature in gerrit, so there is usually little use in wasting words on
> summarizing the changes.
>
> secondly, when really necessary, one can simply post a comment after
> pushing the new patchset.
>

Correct but I think that it can be nice to have and it will reduce
review time. I know
that gerrit can show easily the difference between changes-set but
sometime the people upload the
patch solve the comment in a way that it's nice to be described in
kind of changeset or comment that
should not land in the commit message

Michael

> (*) side notes:
> - when a cover letter is included, it's conventional for it to contain a
> changelog as well. but that doesn't preclude each commit from having
> its own, too.
> - git-send-email --range-diff will generate something akin to gerrit's
> inter-diffs. but as this feature can document commit additions and
> deletions, it exists on a series level, and therefore the output ends
> up in a cover letter.
> but i noticed that people don't use this as a replacement for manual
> changelogs, only an addition. i guess this makes sense, as the purely
> textual range-diff is still a lot harder to read than gerrit's
> inter-diff.
>
> regards

--
Michael Nazzareno Trimarchi
Co-Founder & Chief Executive Officer
M. +39 347 913 2170
mic...@amarulasolutions.com
__________________________________

Amarula Solutions BV
Joop Geesinkweg 125, 1114 AB, Amsterdam, NL
T. +31 (0)85 111 9172
in...@amarulasolutions.com
www.amarulasolutions.com

[Björn Pedersen]

Seems like one of the mostly unused features in gerrit called patchset description: 

https://gerrit-review.googlesource.com/Documentation/concept-patch-sets.html#_description

and 

https://gerrit-review.googlesource.com/Documentation/user-upload.html#patch_set_description

 

regards