From: David Matlack <dmatlack@google.com>
To: Sean Christopherson <seanjc@google.com>
Cc: kvm list <kvm@vger.kernel.org>,
Paolo Bonzini <pbonzini@redhat.com>,
Ben Gardon <bgardon@google.com>
Subject: Re: [PATCH] KVM: x86/mmu: Fix comment mentioning skip_4k
Date: Wed, 26 May 2021 12:00:59 -0700 [thread overview]
Message-ID: <CALzav=dN5sAv8GaH5tQ3nkPAEhufXVTDweQk5NF8GjB+NeDOfQ@mail.gmail.com> (raw)
In-Reply-To: <YK6Ywl57/FXqcSR0@google.com>
On Wed, May 26, 2021 at 11:51 AM Sean Christopherson <seanjc@google.com> wrote:
>
> On Wed, May 26, 2021, David Matlack wrote:
> > On Wed, May 26, 2021 at 10:29 AM Sean Christopherson <seanjc@google.com> wrote:
> > >
> > > Put version information in the subject, otherwise it's not always obvious which
> > > patch you want to be accepted, e.g.
> > >
> > > [PATCH v2] KVM: x86/mmu: Fix comment mentioning skip_4k
> >
> > Got it. My thinking was that I changed the title of the patch so
> > should omit the v2, but that doesn't really make sense.
>
> Ha, yeah, the version should get bumped even if a patch/series gets heavily
> rewritten. There are exceptions (though I'm struggling to think of a good
> example), but even then it's helpful to describe the relationship to any
> previous series.
>
> It's also customery to describe the changes between versions in the cover letter,
> or in the case of a one-off patch, in the part of the patch that git ignores.
>
> And my own personal preference is to also include lore links to previous versions,
> e.g. in this case I would do something like:
>
> v2: Reword comment to document min_level. [sean]
>
> v1: https://lkml.kernel.org/r/20210526163227.3113557-1-dmatlack@google.com
>
> Providing the explicit link in addition to the delta summaray makes it easy for
> reviewers to see the history and understand the context of _why_ changes were
> made. That's especially helpful for reviewers that didn't read/review earlier
> versions.
Great advice. Thanks Sean!
next prev parent reply other threads:[~2021-05-26 19:01 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-26 16:32 [PATCH] KVM: x86/mmu: Fix comment mentioning skip_4k David Matlack
2021-05-26 17:29 ` Sean Christopherson
2021-05-26 17:59 ` David Matlack
2021-05-26 18:51 ` Sean Christopherson
2021-05-26 19:00 ` David Matlack [this message]
2021-05-27 12:01 ` Paolo Bonzini
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='CALzav=dN5sAv8GaH5tQ3nkPAEhufXVTDweQk5NF8GjB+NeDOfQ@mail.gmail.com' \
--to=dmatlack@google.com \
--cc=bgardon@google.com \
--cc=kvm@vger.kernel.org \
--cc=pbonzini@redhat.com \
--cc=seanjc@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
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;
as well as URLs for NNTP newsgroup(s).