X-GM-THRID: 6389791832562204672 X-Received: by 10.176.0.243 with SMTP id 106mr9468072uaj.42.1487822043362; Wed, 22 Feb 2017 19:54:03 -0800 (PST) X-BeenThere: outreachy-kernel@googlegroups.com Received: by 10.107.15.68 with SMTP id x65ls837389ioi.33.gmail; Wed, 22 Feb 2017 19:54:02 -0800 (PST) X-Received: by 10.98.21.19 with SMTP id 19mr1491453pfv.29.1487822042623; Wed, 22 Feb 2017 19:54:02 -0800 (PST) Return-Path: Received: from mail-it0-x243.google.com (mail-it0-x243.google.com. [2607:f8b0:4001:c0b::243]) by gmr-mx.google.com with ESMTPS id e196si572663itc.2.2017.02.22.19.54.02 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 22 Feb 2017 19:54:02 -0800 (PST) Received-SPF: pass (google.com: domain of tahia.khan@gmail.com designates 2607:f8b0:4001:c0b::243 as permitted sender) client-ip=2607:f8b0:4001:c0b::243; Authentication-Results: gmr-mx.google.com; dkim=pass header.i=@gmail.com; spf=pass (google.com: domain of tahia.khan@gmail.com designates 2607:f8b0:4001:c0b::243 as permitted sender) smtp.mailfrom=tahia.khan@gmail.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gmail.com Received: by mail-it0-x243.google.com with SMTP id e137so688103itc.0 for ; Wed, 22 Feb 2017 19:54:02 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=date:from:to:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=CnSKDV9Wtjsk9GjkzbvAFAbHnNMtrRKPnSaWQY5Eq64=; b=f6bmg6a67MZJR5zTlcM8sb9wMMhRintiswMfUQ7K0igVC9pgG2QZXHYfGpem1u0tuz VGRnSO1ACYFfexT+84adKQZgXPu9DxUwA/h1QhnKP4JQVPZ8VCK7NnNAeO5mIj1QH2G7 jPDgg5zWqiRjwj9cjTYnyIM+XSMXm9LqdCfJMSly6rO3qd1WJWLC5luCe2hnVhfu9Z4A D+q2hz9B4xjv6bYz3WX0t41fJSkQYMzxnyPi2nQ31ce8IFYrpDfFswNp0pNe0kj7M1xH QlUq7xwJ0kshbeBRarg/4riKVWt4T3+bVNYqlKy56ko7XnpxHJxvBahMCBWCYpKMFdEq T6nA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=CnSKDV9Wtjsk9GjkzbvAFAbHnNMtrRKPnSaWQY5Eq64=; b=AELqLF8Ee0DQk8xyO48vQ3ZdBb6Ivc216RH0Kd3t3aPf75bMAtDxr6HGZFPTvmHjdw xwZQQzqjG6wl18xrXEXRHWp+H3ujVpGswbs0y11QAbLN/SbWSHqFwbO8aLIMnIuOud7m 9kMkUCMmPAAZLOLxZ27e556QnOAP/KoRBPWCPI0G+/jXhnOFOI5zBkv1Nqk2ibIxrgFC 7ZcM1uxup/VNe5UBtBHZX60S2k2jSJlvmQZPO/MQ5J8c3xU2yIahcDAXXLnxZEHh7IOi vHenILGiPbzvtYT73yXQeISCeoDOdvPxLltPC0etAuvzCipMhcpeSyoW1ecFxXKYVjLs bIHQ== X-Gm-Message-State: AMke39n5wslapvOCR04Ofd7m/AKdBNJ3wqqSiLjsQz/VoYm55bQbuxeKX+hE1oC69xpkaw== X-Received: by 10.107.38.202 with SMTP id m193mr1780373iom.185.1487822042338; Wed, 22 Feb 2017 19:54:02 -0800 (PST) Return-Path: Received: from coolbox (24-212-136-169.cable.teksavvy.com. [24.212.136.169]) by smtp.gmail.com with ESMTPSA id 62sm474985itl.1.2017.02.22.19.54.01 (version=TLS1 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 22 Feb 2017 19:54:01 -0800 (PST) Date: Wed, 22 Feb 2017 22:54:00 -0500 From: Tahia Khan To: arend.vanspriel@broadcom.com, outreachy-kernel@googlegroups.com, aditya.shankar@microchip.com, ganesh.krishna@microchip.com, gregkh@linuxfoundation.org, linux-wireless@vger.kernel.org, devel@driverdev.osusl.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH v2] staging: wilc1000: renames struct tstrRSSI and its members u8Index, u8Full Message-ID: <20170223035400.GA9378@coolbox> References: <20170222171403.GA20626@coolbox> <838d3e67-646d-b2d3-ef7d-5812675db6db@broadcom.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <838d3e67-646d-b2d3-ef7d-5812675db6db@broadcom.com> User-Agent: Mutt/1.5.24 (2015-08-30) On Wed, Feb 22, 2017 at 08:50:31PM +0100, Arend Van Spriel wrote: > On 22-2-2017 18:14, Tahia Khan wrote: > > Fixes multiple camel case checks on struct tstrRSSI from checkpatch.pl: > > > > Avoid CamelCase: > > Avoid CamelCase: > > Avoid CamelCase: > > Just a generic remark that may help you with other changes you will be > making in the linux kernel. Warnings from checkpatch.pl and other tools > are useful, but try to look further than just fixing a warning. > Understand what the code is doing is just as important. > > > Signed-off-by: Tahia Khan > > --- > > drivers/staging/wilc1000/coreconfigurator.h | 8 ++++---- > > drivers/staging/wilc1000/wilc_wfi_cfgoperations.c | 10 +++++----- > > 2 files changed, 9 insertions(+), 9 deletions(-) > > > > diff --git a/drivers/staging/wilc1000/coreconfigurator.h b/drivers/staging/wilc1000/coreconfigurator.h > > index cff1698..5b65c4f 100644 > > --- a/drivers/staging/wilc1000/coreconfigurator.h > > +++ b/drivers/staging/wilc1000/coreconfigurator.h > > @@ -70,9 +70,9 @@ enum connect_status { > > CONNECT_STS_FORCE_16_BIT = 0xFFFF > > }; > > > > -struct tstrRSSI { > > - u8 u8Full; > > - u8 u8Index; > > +struct tstr_RSSI { > > + u8 full; > > + u8 index; > > s8 as8RSSI[NUM_RSSI]; > > So you have a struct here with three members and you choose to only > change the first two. What do you think about the third one just by > looking at it. And what about the name of the struct. What does 'tstr' mean? > > > }; > > > > @@ -93,7 +93,7 @@ struct network_info { > > u8 *ies; > > u16 ies_len; > > void *join_params; > > - struct tstrRSSI str_rssi; > > + struct tstr_RSSI str_rssi; > > u64 tsf_hi; > > }; > > > > diff --git a/drivers/staging/wilc1000/wilc_wfi_cfgoperations.c b/drivers/staging/wilc1000/wilc_wfi_cfgoperations.c > > index f7ce47c..56f133e 100644 > > --- a/drivers/staging/wilc1000/wilc_wfi_cfgoperations.c > > +++ b/drivers/staging/wilc1000/wilc_wfi_cfgoperations.c > > @@ -205,8 +205,8 @@ static u32 get_rssi_avg(struct network_info *network_info) > > { > > u8 i; > > int rssi_v = 0; > > - u8 num_rssi = (network_info->str_rssi.u8Full) ? > > - NUM_RSSI : (network_info->str_rssi.u8Index); > > + u8 num_rssi = (network_info->str_rssi.full) ? > > + NUM_RSSI : (network_info->str_rssi.index); > > so struct tstr_RSSI is really a rssi history buffer so maybe naming it > as such makes it clearer, ie. struct rssi_history_buffer. > > > for (i = 0; i < num_rssi; i++) > > rssi_v += network_info->str_rssi.as8RSSI[i]; > > @@ -346,13 +346,13 @@ static void add_network_to_shadow(struct network_info *pstrNetworkInfo, > > } else { > > ap_index = ap_found; > > } > > - rssi_index = last_scanned_shadow[ap_index].str_rssi.u8Index; > > + rssi_index = last_scanned_shadow[ap_index].str_rssi.index; > > last_scanned_shadow[ap_index].str_rssi.as8RSSI[rssi_index++] = pstrNetworkInfo->rssi; > > if (rssi_index == NUM_RSSI) { > > rssi_index = 0; > > - last_scanned_shadow[ap_index].str_rssi.u8Full = 1; > > + last_scanned_shadow[ap_index].str_rssi.full = 1; > > So the 'full' member is actually a bool and you might type it as such. > > Hope this helps. > > Regards, > Arend > > > } > > - last_scanned_shadow[ap_index].str_rssi.u8Index = rssi_index; > > + last_scanned_shadow[ap_index].str_rssi.index = rssi_index; > > last_scanned_shadow[ap_index].rssi = pstrNetworkInfo->rssi; > > last_scanned_shadow[ap_index].cap_info = pstrNetworkInfo->cap_info; > > last_scanned_shadow[ap_index].ssid_len = pstrNetworkInfo->ssid_len; > > Thanks for the feedback Arend, I really appreciate it. I've decided to go with these changes in my follow-up patch request: - rename tstrRSSI to 'rssi_history_buffer' as Aren suggested since it makes the purpose of the struct clear - remove Hungarian notation from all tstrRSSI members' names - change type of u8Full to bool since it's only ever 1 or 0 - change name of as8RSSI to 'samples' since this buffer is only ever used to compute an average, and the "rssi" prefix is implied by the struct's name - rename str_rssi to rssi_history in the network_info struct for clarity Since my reasoning for these changes deviates from just "renaming to avoid camel casing" (as in the original checkpatch.pl warning), would it still make sense to submit all this in a single patch? I know my commit message needs to change but I wonder if this is too much detail. Tahia