From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([208.118.235.92]:49976) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TGEod-0003F2-4v for qemu-devel@nongnu.org; Mon, 24 Sep 2012 15:59:39 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1TGEoc-0004Fp-0H for qemu-devel@nongnu.org; Mon, 24 Sep 2012 15:59:39 -0400 Received: from mx1.redhat.com ([209.132.183.28]:62857) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TGEob-0004Fe-OO for qemu-devel@nongnu.org; Mon, 24 Sep 2012 15:59:37 -0400 Received: from int-mx12.intmail.prod.int.phx2.redhat.com (int-mx12.intmail.prod.int.phx2.redhat.com [10.5.11.25]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id q8OJxaTb011934 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Mon, 24 Sep 2012 15:59:36 -0400 Date: Mon, 24 Sep 2012 22:01:10 +0200 From: "Michael S. Tsirkin" Message-ID: <20120924200110.GA13340@redhat.com> References: <20120924175746.15361.32976.stgit@bling.home> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20120924175746.15361.32976.stgit@bling.home> Subject: Re: [Qemu-devel] [PATCH] CODING_STYLE: Define how to handle acronyms in CamelCase List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Alex Williamson Cc: qemu-devel@nongnu.org On Mon, Sep 24, 2012 at 12:08:16PM -0600, Alex Williamson wrote: > When creating structure names in CamelCase, it's easy to have > back-to-back capitals when using acronyms (ex. PCIINTxRoutingNotifier, > QEMUSGList, VFIOINTx). In the worst case these can look like macros, > but even adjoining a single, all-caps acronym makes it more difficult > to interpret. For example, is PCIIntxRoutingNotifier sufficiently > more clear? Mixing case, such as VFIOintx isn't truly CamelCase. > Therefore let's abandon all-caps acronyms in CamelCase, resulting in > PciIntxRoutingNotifier, QemuSgList, VfioIntx. > > Cc: Michael Tsirkin > Signed-off-by: Alex Williamson I'm fine with these, but you should ask people like Blue Swirl who really care about coding style rules. > --- > > This is an attempt to formalize and get agreement on name changes > suggested for the vfio-pci driver. VFIO is very prone to these naming > problems. I don't expect to do any massive code churn to correct > these, but I will update vfio-pci to whatever outcome we decide and at > least we'll have a reference rather than per maintainer policy. > Thanks, > > Alex > > CODING_STYLE | 5 +++++ > 1 file changed, 5 insertions(+) > > diff --git a/CODING_STYLE b/CODING_STYLE > index dcbce28..e45ed1a 100644 > --- a/CODING_STYLE > +++ b/CODING_STYLE > @@ -53,6 +53,11 @@ and is therefore likely to be changed. > When wrapping standard library functions, use the prefix qemu_ to alert > readers that they are seeing a wrapped version; otherwise avoid this prefix. > > +When making use of acronyms in CamelCase only capitalize the first character > +of the acronym. This promotes readability and clearly defines the start of > +each word or acronym. For example, instead of PCIBAR, use PciBar. In place > +of QEMUDMAList, use QemuDmaList. > + > 4. Block structure > > Every indented statement is braced; even if the block contains just one