linux-kernel - Re: [PATCH] staging/iio/accel: checkpatch: fixed long lines by moving comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20141227072400.GB4780@sudip-PC>
Date:	Sat, 27 Dec 2014 12:54:00 +0530
From:	Sudip Mukherjee <sudipm.mukherjee@...il.com>
To:	Jonathan Cameron <jic23@...nel.org>
Cc:	Helene Gsaenger <helene.gsaenger@...dium.fau.de>,
	simone.weiss@....de, linux-kernel@...cs.fau.de, lars@...afoo.de,
	Michael.Hennerich@...log.com, knaack.h@....de, pmeerw@...erw.net,
	gregkh@...uxfoundation.org, linux-iio@...r.kernel.org,
	devel@...verdev.osuosl.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] staging/iio/accel: checkpatch: fixed long lines by
 moving comments

On Fri, Dec 26, 2014 at 10:00:00AM +0000, Jonathan Cameron wrote:
> On 22/12/14 13:48, Sudip Mukherjee wrote:
> > On Mon, Dec 22, 2014 at 02:23:42AM +0100, Helene Gsaenger wrote:
> >> Signed-off-by: Helene Gsaenger <helene.gsaenger@...dium.fau.de>
> >> Signed-off-by: Simone Weiss <simone.weiss@....de>
> >> ---
> >>  drivers/staging/iio/accel/adis16203.h | 41 ++++++++++++++++++++++++++---------
> >>  1 file changed, 31 insertions(+), 10 deletions(-)
> >>
> >> diff --git a/drivers/staging/iio/accel/adis16203.h b/drivers/staging/iio/accel/adis16203.h
> >> index acc688d..fefe2f9 100644
> >> --- a/drivers/staging/iio/accel/adis16203.h
> >> +++ b/drivers/staging/iio/accel/adis16203.h
> >> @@ -16,26 +16,47 @@
> >>  #define ADIS16203_ALM_SMPL2      0x26 /* Alarm 2, sample period */
> >>  #define ADIS16203_ALM_CTRL       0x28 /* Alarm control */
> >>  #define ADIS16203_AUX_DAC        0x30 /* Auxiliary DAC data */
> >> -#define ADIS16203_GPIO_CTRL      0x32 /* General-purpose digital input/output control */
> >> +#define ADIS16203_GPIO_CTRL      0x32 /* General-purpose digital input/output
> >> +				       * control */
> >>  #define ADIS16203_MSC_CTRL       0x34 /* Miscellaneous control */
> >> -#define ADIS16203_SMPL_PRD       0x36 /* Internal sample period (rate) control */
> >> +#define ADIS16203_SMPL_PRD       0x36 /* Internal sample period (rate)
> >> +				       * control */
> > 
> > this is not the style for multiline comments. Check in CodingStyle.
> > and besides, I think it will be better if you can put the comments in a line of its own.
> + remember checkpatch is only for guidance.  Some rules such as the 80 character limit
> are often ignored if clarity would be gained by doing so, or if as here a large patch
> would be needed (move all comments to separate lines) in order to meet the 80 character
> line limit for a couple of cases.

ofcourse checkpatch is only for guidance, and we need to use our own judgement to decide.
here I mentioned separate line because Helene Gsaenger has sent the patch splitting some commments in the second line, which was not looking good.
Personally, I will like comments beside the #define, so that while reading the code, i can immediately see what that #define is doing.

Sudip


> > 
> > thanks
> > sudip
> >>  #define ADIS16203_AVG_CNT        0x38 /* Operation, filter configuration */
> >>  #define ADIS16203_SLP_CNT        0x3A /* Operation, sleep mode control */
> >>  #define ADIS16203_DIAG_STAT      0x3C /* Diagnostics, system status register */
> >>  #define ADIS16203_GLOB_CMD       0x3E /* Operation, system command register */
> >>  
> >>  /* MSC_CTRL */
> >> -#define ADIS16203_MSC_CTRL_PWRUP_SELF_TEST	(1 << 10) /* Self-test at power-on: 1 = disabled, 0 = enabled */
> >> -#define ADIS16203_MSC_CTRL_REVERSE_ROT_EN	(1 << 9)  /* Reverses rotation of both inclination outputs */
> >> +#define ADIS16203_MSC_CTRL_PWRUP_SELF_TEST	(1 << 10) /* Self-test at
> >> +							   * power-on:
> >> +							   * 1 = disabled,
> >> +							   * 0 = enabled */
> >> +#define ADIS16203_MSC_CTRL_REVERSE_ROT_EN	(1 << 9)  /* Reverses rotation
> >> +							   * of both
> >> +							   * inclination
> >> +							   * outputs */
> >>  #define ADIS16203_MSC_CTRL_SELF_TEST_EN	        (1 << 8)  /* Self-test enable */
> >> -#define ADIS16203_MSC_CTRL_DATA_RDY_EN	        (1 << 2)  /* Data-ready enable: 1 = enabled, 0 = disabled */
> >> -#define ADIS16203_MSC_CTRL_ACTIVE_HIGH	        (1 << 1)  /* Data-ready polarity: 1 = active high, 0 = active low */
> >> -#define ADIS16203_MSC_CTRL_DATA_RDY_DIO1	(1 << 0)  /* Data-ready line selection: 1 = DIO1, 0 = DIO0 */
> >> +#define ADIS16203_MSC_CTRL_DATA_RDY_EN	        (1 << 2)  /* Data-ready enable:
> >> +							   * 1 = enabled,
> >> +							   * 0 = disabled */
> >> +#define ADIS16203_MSC_CTRL_ACTIVE_HIGH	        (1 << 1)  /* Data-ready
> >> +							   * polarity:
> >> +							   * 1 = active high,
> >> +							   * 0 = active low */
> >> +#define ADIS16203_MSC_CTRL_DATA_RDY_DIO1	(1 << 0)  /* Data-ready line
> >> +							   * selection:
> >> +							   * 1 = DIO1,
> >> +							   * 0 = DIO0 */
> >>  
> >>  /* DIAG_STAT */
> >> -#define ADIS16203_DIAG_STAT_ALARM2        (1<<9) /* Alarm 2 status: 1 = alarm active, 0 = alarm inactive */
> >> -#define ADIS16203_DIAG_STAT_ALARM1        (1<<8) /* Alarm 1 status: 1 = alarm active, 0 = alarm inactive */
> >> -#define ADIS16203_DIAG_STAT_SELFTEST_FAIL_BIT 5 /* Self-test diagnostic error flag */
> >> +#define ADIS16203_DIAG_STAT_ALARM2        (1<<9) /* Alarm 2 status:
> >> +						  * 1 = alarm active,
> >> +						  * 0 = alarm inactive */
> >> +#define ADIS16203_DIAG_STAT_ALARM1        (1<<8) /* Alarm 1 status:
> >> +						  * 1 = alarm active,
> >> +						  * 0 = alarm inactive */
> >> +#define ADIS16203_DIAG_STAT_SELFTEST_FAIL_BIT 5 /* Self-test diagnostic error
> >> +						 * flag */
> >>  #define ADIS16203_DIAG_STAT_SPI_FAIL_BIT      3 /* SPI communications failure */
> >>  #define ADIS16203_DIAG_STAT_FLASH_UPT_BIT     2 /* Flash update failure */
> >>  #define ADIS16203_DIAG_STAT_POWER_HIGH_BIT    1 /* Power supply above 3.625 V */
> >> -- 
> >> 1.9.1
> >>
> >> --
> >> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> >> the body of a message to majordomo@...r.kernel.org
> >> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> >> Please read the FAQ at  http://www.tux.org/lkml/
> 
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/