From mboxrd@z Thu Jan 1 00:00:00 1970 From: Greg KH Date: Tue, 28 Nov 2017 12:57:22 +0000 Subject: Re: [PATCH 1/2] staging: sm750fb: Fix coding style in ddk750_sii164.h Message-Id: <20171128125722.GA32039@kroah.com> List-Id: References: <20171125182636.15245-1-j.lacomis@gmail.com> <20171127094622.phmx4ej2fljcytce@mwanda> <20171127143727.GA4270@gs17931.sp.cs.cmu.edu> In-Reply-To: <20171127143727.GA4270@gs17931.sp.cs.cmu.edu> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: Jeremy Lacomis Cc: Geert Uytterhoeven , driverdevel , Linux Fbdev development list , Teddy Wang , "linux-kernel@vger.kernel.org" , Sudip Mukherjee , Dan Carpenter On Mon, Nov 27, 2017 at 09:37:27AM -0500, Jeremy Lacomis wrote: > On Mon, Nov 27, 2017 at 11:45:00AM +0100, Geert Uytterhoeven wrote: > > On Mon, Nov 27, 2017 at 10:46 AM, Dan Carpenter > > wrote: > > > On Sat, Nov 25, 2017 at 01:26:35PM -0500, Jeremy Lacomis wrote: > > >> This patch to ddk750_sii164.h fixes line length warnings found by the > > >> checkpatch.pl script and reformats comments uniformly. > > >> > > >> Signed-off-by: Jeremy Lacomis > > >> --- > > >> drivers/staging/sm750fb/ddk750_sii164.h | 57 +++++++++++++-------------------- > > >> 1 file changed, 22 insertions(+), 35 deletions(-) > > >> > > >> diff --git a/drivers/staging/sm750fb/ddk750_sii164.h b/drivers/staging/sm750fb/ddk750_sii164.h > > >> index 2e9a88cd6af3..393a3c5be3ae 100644 > > >> --- a/drivers/staging/sm750fb/ddk750_sii164.h > > >> +++ b/drivers/staging/sm750fb/ddk750_sii164.h > > >> @@ -4,15 +4,20 @@ > > >> > > >> #define USE_DVICHIP > > >> > > >> -/* Hot Plug detection mode structure */ > > >> +/* > > >> + * Hot Plug detection mode structure: > > >> + * Disable Hot Plug output bit (always high). > > >> + * Use Monitor Detect Interrupt bit. > > >> + * Use Receiver Sense detect bit. > > >> + * Use Hot Plug detect bit. > > >> + */ > > >> enum sii164_hot_plug_mode { > > >> - SII164_HOTPLUG_DISABLE = 0, /* Disable Hot Plug output bit (always high). */ > > >> - SII164_HOTPLUG_USE_MDI, /* Use Monitor Detect Interrupt bit. */ > > >> - SII164_HOTPLUG_USE_RSEN, /* Use Receiver Sense detect bit. */ > > >> - SII164_HOTPLUG_USE_HTPLG /* Use Hot Plug detect bit. */ > > >> + SII164_HOTPLUG_DISABLE = 0, > > >> + SII164_HOTPLUG_USE_MDI, > > >> + SII164_HOTPLUG_USE_RSEN, > > >> + SII164_HOTPLUG_USE_HTPLG > > >> }; > > > > > > I feel like this makes it less readable. The original was better. > > > > And more error prone. > > Thanks for taking the time to review my patch, I'm just getting into kernel > development and am trying to do as little disservice as possible while learning > the process. > > For something like this, would using the kernel-doc format make more sense, or > should the original inline comments be kept? I found the original difficult to > read because my terminal was just small enough that this didn't fit. kernel-doc might be good, but it also might just be worth it to leave it alone as it might be too much work. thanks, greg k-h From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752476AbdK1M5V (ORCPT ); Tue, 28 Nov 2017 07:57:21 -0500 Received: from mail.linuxfoundation.org ([140.211.169.12]:46848 "EHLO mail.linuxfoundation.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752365AbdK1M5S (ORCPT ); Tue, 28 Nov 2017 07:57:18 -0500 Date: Tue, 28 Nov 2017 13:57:22 +0100 From: Greg KH To: Jeremy Lacomis Cc: Geert Uytterhoeven , driverdevel , Linux Fbdev development list , Teddy Wang , "linux-kernel@vger.kernel.org" , Sudip Mukherjee , Dan Carpenter Subject: Re: [PATCH 1/2] staging: sm750fb: Fix coding style in ddk750_sii164.h Message-ID: <20171128125722.GA32039@kroah.com> References: <20171125182636.15245-1-j.lacomis@gmail.com> <20171127094622.phmx4ej2fljcytce@mwanda> <20171127143727.GA4270@gs17931.sp.cs.cmu.edu> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20171127143727.GA4270@gs17931.sp.cs.cmu.edu> User-Agent: Mutt/1.9.1 (2017-09-22) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Mon, Nov 27, 2017 at 09:37:27AM -0500, Jeremy Lacomis wrote: > On Mon, Nov 27, 2017 at 11:45:00AM +0100, Geert Uytterhoeven wrote: > > On Mon, Nov 27, 2017 at 10:46 AM, Dan Carpenter > > wrote: > > > On Sat, Nov 25, 2017 at 01:26:35PM -0500, Jeremy Lacomis wrote: > > >> This patch to ddk750_sii164.h fixes line length warnings found by the > > >> checkpatch.pl script and reformats comments uniformly. > > >> > > >> Signed-off-by: Jeremy Lacomis > > >> --- > > >> drivers/staging/sm750fb/ddk750_sii164.h | 57 +++++++++++++-------------------- > > >> 1 file changed, 22 insertions(+), 35 deletions(-) > > >> > > >> diff --git a/drivers/staging/sm750fb/ddk750_sii164.h b/drivers/staging/sm750fb/ddk750_sii164.h > > >> index 2e9a88cd6af3..393a3c5be3ae 100644 > > >> --- a/drivers/staging/sm750fb/ddk750_sii164.h > > >> +++ b/drivers/staging/sm750fb/ddk750_sii164.h > > >> @@ -4,15 +4,20 @@ > > >> > > >> #define USE_DVICHIP > > >> > > >> -/* Hot Plug detection mode structure */ > > >> +/* > > >> + * Hot Plug detection mode structure: > > >> + * Disable Hot Plug output bit (always high). > > >> + * Use Monitor Detect Interrupt bit. > > >> + * Use Receiver Sense detect bit. > > >> + * Use Hot Plug detect bit. > > >> + */ > > >> enum sii164_hot_plug_mode { > > >> - SII164_HOTPLUG_DISABLE = 0, /* Disable Hot Plug output bit (always high). */ > > >> - SII164_HOTPLUG_USE_MDI, /* Use Monitor Detect Interrupt bit. */ > > >> - SII164_HOTPLUG_USE_RSEN, /* Use Receiver Sense detect bit. */ > > >> - SII164_HOTPLUG_USE_HTPLG /* Use Hot Plug detect bit. */ > > >> + SII164_HOTPLUG_DISABLE = 0, > > >> + SII164_HOTPLUG_USE_MDI, > > >> + SII164_HOTPLUG_USE_RSEN, > > >> + SII164_HOTPLUG_USE_HTPLG > > >> }; > > > > > > I feel like this makes it less readable. The original was better. > > > > And more error prone. > > Thanks for taking the time to review my patch, I'm just getting into kernel > development and am trying to do as little disservice as possible while learning > the process. > > For something like this, would using the kernel-doc format make more sense, or > should the original inline comments be kept? I found the original difficult to > read because my terminal was just small enough that this didn't fit. kernel-doc might be good, but it also might just be worth it to leave it alone as it might be too much work. thanks, greg k-h