All of lore.kernel.org
 help / color / mirror / Atom feed
From: Sean Christopherson <seanjc@google.com>
To: David Matlack <dmatlack@google.com>
Cc: Paolo Bonzini <pbonzini@redhat.com>,
	Ben Gardon <bgardon@google.com>,
	kvm@vger.kernel.org, Andrew Jones <andrew.jones@linux.dev>,
	Colton Lewis <coltonlewis@google.com>,
	Ricardo Koller <ricarkol@google.com>
Subject: Re: [PATCH v2 1/3] KVM: selftests: Rename perf_test_util.[ch] to memstress.[ch]
Date: Wed, 12 Oct 2022 19:21:28 +0000	[thread overview]
Message-ID: <Y0cTuKbeWoGSXPFT@google.com> (raw)
In-Reply-To: <20221012165729.3505266-2-dmatlack@google.com>

On Wed, Oct 12, 2022, David Matlack wrote:
> Rename the perf_test_util.[ch] files to memstress.[ch]. Symbols are
> renamed in the following commit to reduce the amount of churn here in

Heh, "following commit" is now stale.  This is why I encourage using ambiguous
phrases, e.g. "in a future commit".

This should also be phrased as a command, not a statement of truth.  E.g. in the
extremely unlikely scenario that symbols are never renamed, this statement is
wrong, whereas something like

  Defer renaming symbols to a future patch to reduce the amount of churn
  here in the hopes of playing nice with git's file rename detection.

states only what is done in the context of this patch while still calling out
that the intent is to rename symbols in the (near) future.

To be 100% clear, I'm not saying don't describe future changes, there's a _lot_
of value in knowing that a patch is prep work for the future.  I'm saying don't
explicitly predict the future, because occassionally the prediction will be wrong
and the changelog ends up confusing archaeologists.

> hopes of playiing nice with git's file rename detection.

s/playiing/playing

> The name "memstress" was chosen to better describe the functionality
> proveded by this library, which is to create and run a VM that
> reads/writes to guest memory on all vCPUs in parallel.
> 
> "memstress" also contains the same number of chracters as "perf_test",
> making it a drop-in replacement in symbols, e.g. function names, without
> impacting line lengths. Also the lack of underscore between "mem" and
> "stress" makes it clear "memstress" is a noun.
> 
> Signed-off-by: David Matlack <dmatlack@google.com>

Changelog nits aside,

Reviewed-by: Sean Christopherson <seanjc@google.com>

  reply	other threads:[~2022-10-12 19:21 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-12 16:57 [PATCH v2 0/3] KVM: selftests: Rename perf_test_util to memstress David Matlack
2022-10-12 16:57 ` [PATCH v2 1/3] KVM: selftests: Rename perf_test_util.[ch] to memstress.[ch] David Matlack
2022-10-12 19:21   ` Sean Christopherson [this message]
2022-10-13 16:15     ` David Matlack
2022-10-12 16:57 ` [PATCH v2 2/3] KVM: selftests: Rename pta (short for perf_test_args) to args David Matlack
2022-10-12 19:24   ` Sean Christopherson
2022-10-12 16:57 ` [PATCH v2 3/3] KVM: selftests: Rename perf_test_util symbols to memstress David Matlack
2022-10-12 19:26   ` Sean Christopherson
2022-10-13 14:03 ` [PATCH v2 0/3] KVM: selftests: Rename perf_test_util " Andrew Jones

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=Y0cTuKbeWoGSXPFT@google.com \
    --to=seanjc@google.com \
    --cc=andrew.jones@linux.dev \
    --cc=bgardon@google.com \
    --cc=coltonlewis@google.com \
    --cc=dmatlack@google.com \
    --cc=kvm@vger.kernel.org \
    --cc=pbonzini@redhat.com \
    --cc=ricarkol@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.