linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@jic23.retrosnub.co.uk>
To: Lee Jones <lee.jones@linaro.org>
Cc: knaack.h@gmx.de, lars@metafoo.de, pmeerw@pmeerw.net,
	linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, linux-iio@vger.kernel.org,
	Michael Hennerich <Michael.Hennerich@analog.com>,
	Barry Song <21cnbao@gmail.com>, Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH 12/30] iio: gyro: adis16080: Fix formatting issue and compiler attribute ordering
Date: Thu, 17 Sep 2020 19:33:02 +0100	[thread overview]
Message-ID: <20200917193302.65e922c0@archlinux> (raw)
In-Reply-To: <20200718155442.14c420db@archlinux>

On Sat, 18 Jul 2020 15:54:42 +0100
Jonathan Cameron <jic23@kernel.org> wrote:

> On Thu, 16 Jul 2020 14:59:10 +0100
> Lee Jones <lee.jones@linaro.org> wrote:
> 
> > Kerneldoc expects attributes/parameters to be in '@*.: ' format and
> > gets confused if the variable does not follow the type/attribute
> > definitions.
> > 
> > Fixes the following W=1 kernel build warning(s):
> > 
> >  drivers/iio/gyro/adis16080.c:49: warning: Function parameter or member 'lock' not described in 'adis16080_state'
> >  drivers/iio/gyro/adis16080.c:49: warning: Function parameter or member '____cacheline_aligned' not described in 'adis16080_state'
> > 
> > Cc: Michael Hennerich <Michael.Hennerich@analog.com>
> > Cc: Barry Song <21cnbao@gmail.com>
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>  
> Hmm. You are going to have an awful lot of those ____cacheline_aligned ones.
> 
> Might be worth thinking about whether we fix kernel-doc to cope with those.
> 
> A quick grep suggests the vast majority of users of this have it after
> the element name.
> 
> @Jon Corbet :  What do you think?  Looks like there is special
> handling already for ____cacheline_aligned_in_smp. Should we extend
> that to this case?

Applied with the ____cacheline_aligned bit dropped as Jon took the patch
to stop kernel-doc complaining about this.

thanks,

Jonathan

> 
> Jonathan
> 
> 
> 
> > ---
> >  drivers/iio/gyro/adis16080.c | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/drivers/iio/gyro/adis16080.c b/drivers/iio/gyro/adis16080.c
> > index 1b84b8e112fe1..f38f9abcccbb5 100644
> > --- a/drivers/iio/gyro/adis16080.c
> > +++ b/drivers/iio/gyro/adis16080.c
> > @@ -38,14 +38,14 @@ struct adis16080_chip_info {
> >   * @us:			actual spi_device to write data
> >   * @info:		chip specific parameters
> >   * @buf:		transmit or receive buffer
> > - * @lock		lock to protect buffer during reads
> > + * @lock:		lock to protect buffer during reads
> >   **/
> >  struct adis16080_state {
> >  	struct spi_device		*us;
> >  	const struct adis16080_chip_info *info;
> >  	struct mutex			lock;
> >  
> > -	__be16 buf ____cacheline_aligned;
> > +	__be16 ____cacheline_aligned buf;
> >  };
> >  
> >  static int adis16080_read_sample(struct iio_dev *indio_dev,  
> 


  reply	other threads:[~2020-09-17 18:34 UTC|newest]

Thread overview: 71+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-16 13:58 [PATCH 00/30] First batch of W=1 fixes for IIO Lee Jones
2020-07-16 13:58 ` [PATCH 01/30] iio: adc: ad_sigma_delta: Remove unused variable 'ret' Lee Jones
2020-07-18 14:24   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 02/30] iio: accel: bma220_spi: Do not define 'struct acpi_device_id' when !CONFIG_ACPI Lee Jones
2020-07-18 14:26   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 03/30] iio: common: ms_sensors: ms_sensors_i2c: Fix misspelling of parameter 'client' Lee Jones
2020-07-18 14:27   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 04/30] iio: adc: ad7298: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-18 14:30   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 05/30] iio: chemical: sgp30: Add description for sgp_read_cmd()'s 'duration_us' Lee Jones
2020-07-18 14:33   ` Jonathan Cameron
2020-09-17 18:33     ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 06/30] iio: adc: ad7923: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-18 14:35   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 07/30] iio: dac: ad5360: Fix kerneldoc attribute formatting for 'lock' Lee Jones
2020-07-18 14:36   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 08/30] iio: dac: ad5380: " Lee Jones
2020-07-18 14:36   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 09/30] iio: dummy: iio_simple_dummy: Demote unworthy kerneldocs and correct misspelling Lee Jones
2020-07-18 14:39   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 10/30] iio: dummy: iio_simple_dummy: Add newline after function-end Lee Jones
2020-07-18 14:40   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 11/30] iio: dac: ad5421: Fix kerneldoc attribute formatting for 'lock' Lee Jones
2020-07-18 14:42   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 12/30] iio: gyro: adis16080: Fix formatting issue and compiler attribute ordering Lee Jones
2020-07-18 14:54   ` Jonathan Cameron
2020-09-17 18:33     ` Jonathan Cameron [this message]
2020-07-16 13:59 ` [PATCH 13/30] iio: dummy: iio_simple_dummy_events: Demote file header and supply descriptions for val2 params Lee Jones
2020-07-18 14:55   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 14/30] iio: dac: ad5064: Value returned by ad5064_vref_name may not be 'const * const' Lee Jones
2020-07-18 14:57   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 15/30] iio: dummy: iio_dummy_evgen: Demote file header and supply description for 'irq_sim_domain' Lee Jones
2020-07-18  9:24   ` Bartosz Golaszewski
2020-07-18 15:00     ` Jonathan Cameron
2020-09-17 18:32       ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 16/30] iio: adc: ad7887: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-18 15:01   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 17/30] iio: adc: ad7949: Fix misspelling issue and compiler attribute ordering Lee Jones
2020-07-18 15:03   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 18/30] iio: dummy: iio_simple_dummy_buffer: Demote file header and correct misspelling Lee Jones
2020-07-18 15:02   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 19/30] iio: dac: ad5064: Fix a few kerneldoc misdemeanours Lee Jones
2020-07-18 15:04   ` Jonathan Cameron
2020-09-17 18:31   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 20/30] iio: dac: ad5446: Complete 'struct ad5446_state' doc and demote unworthy kerneldocs Lee Jones
2020-07-18 15:05   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 21/30] iio: dac: ad5449: Fix kerneldoc attribute formatting for 'lock' Lee Jones
2020-07-18 15:06   ` Jonathan Cameron
2020-07-18 15:07   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 22/30] iio: dac: ad5755: " Lee Jones
2020-07-18 15:08   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 23/30] iio: dac: ad5758: Move and fix-up kerneldoc header and demote unworthy kerneldoc Lee Jones
2020-07-18 15:09   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 24/30] iio: dac: ad5761: Fix kerneldoc attribute formatting for 'lock' Lee Jones
2020-07-18 15:10   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 25/30] iio: dac: ad5764: Fix misdocumenting and formatting error Lee Jones
2020-07-18 15:10   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 26/30] iio: dac: ad5791: Complete 'struct ad5791_chip_info' documentation Lee Jones
2020-07-18 15:12   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 27/30] iio: light: cm32181: Fix formatting and docrot issues in cm32181_acpi_get_cpm() Lee Jones
2020-07-18 15:14   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 28/30] iio: magnetometer: mmc35240: Fix function header formatting Lee Jones
2020-07-18 15:16   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 29/30] iio: imu: kmx61: Fix formatting in kerneldoc function headers Lee Jones
2020-07-18 15:17   ` Jonathan Cameron
2020-07-16 13:59 ` [PATCH 30/30] iio: dac: ad7303: Complete 'struct ad7303_state' doc and reorder compiler attribute Lee Jones
2020-07-18 15:18   ` Jonathan Cameron
2020-09-17 18:29   ` Jonathan Cameron
2020-09-17 18:30   ` Jonathan Cameron
2020-07-18 14:42 ` [PATCH 00/30] First batch of W=1 fixes for IIO Jonathan Cameron
2020-07-20  7:51   ` Lee Jones

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200917193302.65e922c0@archlinux \
    --to=jic23@jic23.retrosnub.co.uk \
    --cc=21cnbao@gmail.com \
    --cc=Michael.Hennerich@analog.com \
    --cc=corbet@lwn.net \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=lee.jones@linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pmeerw@pmeerw.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).