From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([208.118.235.92]:34696) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1THvYq-0008QL-Bc for qemu-devel@nongnu.org; Sat, 29 Sep 2012 07:50:21 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1THvYp-0005ZG-85 for qemu-devel@nongnu.org; Sat, 29 Sep 2012 07:50:20 -0400 Received: from mail-ie0-f173.google.com ([209.85.223.173]:63321) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1THvYp-0005Yi-3C for qemu-devel@nongnu.org; Sat, 29 Sep 2012 07:50:19 -0400 Received: by iea17 with SMTP id 17so8523056iea.4 for ; Sat, 29 Sep 2012 04:50:18 -0700 (PDT) MIME-Version: 1.0 In-Reply-To: <87obks5tu1.fsf@codemonkey.ws> References: <20120924175746.15361.32976.stgit@bling.home> <87obks5tu1.fsf@codemonkey.ws> From: Blue Swirl Date: Sat, 29 Sep 2012 11:49:58 +0000 Message-ID: Content-Type: text/plain; charset=UTF-8 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: Anthony Liguori Cc: Alex Williamson , qemu-devel@nongnu.org, mst@redhat.com On Wed, Sep 26, 2012 at 9:59 PM, Anthony Liguori wrote: > Alex Williamson writes: > >> 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 >> --- >> >> 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. >> + > > I'd prefer not to do this. > > We do both within QEMU and I think that's fine. By choosing one vs. the > other we just create a lot of friction because now people have to > introduce structures that aren't consistent with the rest of the file. I think PCIBAR and PciBar look equally ugly, so I'd agree. > > Either is fine IMHO. > > Regards, > > Anthony Liguori > >> 4. Block structure >> >> Every indented statement is braced; even if the block contains just one >