Re: On patch series version tags, and also cover letters (was: [PATCH v2 2/2] Added parameter to take screenshot with screendump as PNG)

["Daniel P. Berrangé" <berrange@redhat.com>]

On Tue, Mar 29, 2022 at 09:59:55AM +0200, Markus Armbruster wrote:
> Kshitij Suri <kshitij.suri@nutanix.com> writes:
> 
> > On 29/03/22 12:12 pm, Markus Armbruster wrote:
> >> If I count correctly, this is the fifth posting tagged "v2".  Don't do
> >> that, please, as it's quite confusing.
> >>
> > Thank you for your review and I apologise for that since I am fairly
> > new to upstreaming. As per what I read version updates should be done
> > only when there are significant design changes to the patch which
> > didn't happen in the v2 version. Will update it to v3 and send the
> > patch.
> 
> We all make mistakes :)
> 
> The purpose of the version tag in the subject is to help humans with
> keeping track of patch submissions.  Increment it for every submission.
> 
> If you need to resend a submission completely unchanged for some reason,
> you may want to keep the tag and add "RESEND".
> 
> A cover letter (git format-patch --cover-letter) lets you write an
> introduction to the whole series.  Simple series may not need an
> introduction, but complex ones do.  I always use one except when the
> "series" is a single patch.
> 
> Keeping a change log in the cover letter helps people who already
> reviewed previous iterations.

FYI, using the 'git-publish' tool instead of 'git send-email' or
'git format-patch' helps you do all these things. It automatically
sets & increments the version number, it prompts for a cover letter
and remembers what you wrote next time. 

With regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|