All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Philippe Mathieu-Daudé" <philmd@redhat.com>
To: Alexey Kardashevskiy <aik@ozlabs.ru>,
	David Gibson <david@gibson.dropbear.id.au>,
	clg@kaod.org, groug@kaod.org, agraf@suse.de, lvivier@redhat.com
Cc: qemu-ppc@nongnu.org, qemu-devel@nongnu.org
Subject: Re: [Qemu-devel] [PATCH] spapr: Use CamelCase properly
Date: Thu, 7 Mar 2019 11:34:25 +0100	[thread overview]
Message-ID: <8b4397a2-ac07-eac1-9f49-5e6d439cb688@redhat.com> (raw)
In-Reply-To: <ad194b40-507d-5de1-dc1c-23adb046fac7@ozlabs.ru>

On 3/7/19 6:38 AM, Alexey Kardashevskiy wrote:
> On 07/03/2019 16:21, David Gibson wrote:
>> The qemu coding standard is to use CamelCase for type and structure names,
>> and the pseries code follows that... sort of.  There are quite a lot of
>> places where we bend the rules in order to preserve the capitalization of
>> internal acronyms like "PHB", "TCE", "DIMM" and most commonly "sPAPR".
>>
>> That was a bad idea - it frequently leads to names ending up with hard to
>> read clusters of capital letters, and means they don't catch the eye as
>> type identifiers, which is kind of the point of the CamelCase convention in
>> the first place.
>>
>> In short, keeping type identifiers look like CamelCase is more important
>> than preserving standard capitalization of internal "words".  So, this
>> patch renames a heap of spapr internal type names to a more standard
>> CamelCase.
>>
>> In addition to case changes, we also make some other identifier renames:
>>   VIOsPAPR* -> SpaprVio*
>>     The reverse word ordering was only ever used to mitigate the capital
>>     cluster, so revert to the natural ordering.
>>   VIOsPAPRVTYDevice -> SpaprVioVty
>>   VIOsPAPRVLANDevice -> SpaprVioVlan
>>     Brevity, since the "Device" didn't add useful information
>>   sPAPRDRConnector -> SpaprDrc
>>   sPAPRDRConnectorClass -> SpaprDrcClass
>>     Brevity, and makes it clearer this is the same thing as a "DRC"
>>     mentioned in many other places in the code
>>
>> This is 100% a mechanical search-and-replace patch. It will, however,
>> conflict with essentially any and all outstanding patches touching the
>> spapr code.
> 
> 
> so it would be nice to have the script to fix those outstanding patches
> before reposting.

What I usually do:

$ sed -i 's/sPAPRDRConnectorClass/SpaprDrcClass/' \
  $(git grep -l sPAPRDRConnectorClass)

> 
> 
>>
>> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
>> ---
>> Changes since RFC:
>>  * Added a number of extra renames for brevity and/or clarity
>>  * Fixed couple of places the new capitalization still wasn't right
>>

  reply	other threads:[~2019-03-07 10:34 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-07  5:21 [Qemu-devel] [PATCH] spapr: Use CamelCase properly David Gibson
2019-03-07  5:38 ` Alexey Kardashevskiy
2019-03-07 10:34   ` Philippe Mathieu-Daudé [this message]
2019-03-08  0:14   ` David Gibson
2019-03-11  9:48 ` Greg Kurz

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=8b4397a2-ac07-eac1-9f49-5e6d439cb688@redhat.com \
    --to=philmd@redhat.com \
    --cc=agraf@suse.de \
    --cc=aik@ozlabs.ru \
    --cc=clg@kaod.org \
    --cc=david@gibson.dropbear.id.au \
    --cc=groug@kaod.org \
    --cc=lvivier@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-ppc@nongnu.org \
    /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.