diff mbox series

[v2,3/9] iio: accel: bmc150: Drop duplicated documentation of supported chips

Message ID 20210610122126.50504-4-stephan@gerhold.net (mailing list archive)
State Superseded, archived
Headers show
Series iio: accel: bmc150: Add support for BMA253/BMA254 | expand

Commit Message

Stephan Gerhold June 10, 2021, 12:21 p.m. UTC
The chips supported by the bmc150-accel driver are clearly documented
in Kconfig, in the bmc150_accel_chip_info_tbl as well as in all the
device ID tables in the I2C/SPI drivers. It's easy to forget to update
the lists in the file header. Drop those entirely to reduce the amount
of changes required to add new chip variants.

Signed-off-by: Stephan Gerhold <stephan@gerhold.net>
---
New patch in v2. Originally I tried to reorder those too but then it
caused conflicts in all my following patches so I'm not convinced
it's worth to try and keep those up to date.
---
 drivers/iio/accel/bmc150-accel-core.c | 10 +---------
 drivers/iio/accel/bmc150-accel-i2c.c  | 10 +---------
 2 files changed, 2 insertions(+), 18 deletions(-)

Comments

Andy Shevchenko June 10, 2021, 12:45 p.m. UTC | #1
On Thu, Jun 10, 2021 at 3:24 PM Stephan Gerhold <stephan@gerhold.net> wrote:
>
> The chips supported by the bmc150-accel driver are clearly documented
> in Kconfig, in the bmc150_accel_chip_info_tbl as well as in all the
> device ID tables in the I2C/SPI drivers. It's easy to forget to update
> the lists in the file header. Drop those entirely to reduce the amount
> of changes required to add new chip variants.
>
> Signed-off-by: Stephan Gerhold <stephan@gerhold.net>
> ---
> New patch in v2. Originally I tried to reorder those too but then it
> caused conflicts in all my following patches so I'm not convinced
> it's worth to try and keep those up to date.

It's not user-visible, so I'm fine, but users should have a
possibility to know about supported chips in the Kconfig option.

Assuming above is done deal,
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>

> ---
>  drivers/iio/accel/bmc150-accel-core.c | 10 +---------
>  drivers/iio/accel/bmc150-accel-i2c.c  | 10 +---------
>  2 files changed, 2 insertions(+), 18 deletions(-)
>
> diff --git a/drivers/iio/accel/bmc150-accel-core.c b/drivers/iio/accel/bmc150-accel-core.c
> index a0df704730ee..6fb025b4228f 100644
> --- a/drivers/iio/accel/bmc150-accel-core.c
> +++ b/drivers/iio/accel/bmc150-accel-core.c
> @@ -1,14 +1,6 @@
>  // SPDX-License-Identifier: GPL-2.0-only
>  /*
> - * 3-axis accelerometer driver supporting following Bosch-Sensortec chips:
> - *  - BMC150
> - *  - BMI055
> - *  - BMA255
> - *  - BMA250E
> - *  - BMA222
> - *  - BMA222E
> - *  - BMA280
> - *
> + * 3-axis accelerometer driver supporting many Bosch-Sensortec chips
>   * Copyright (c) 2014, Intel Corporation.
>   */
>
> diff --git a/drivers/iio/accel/bmc150-accel-i2c.c b/drivers/iio/accel/bmc150-accel-i2c.c
> index b8bda0dfb495..a0e2782580b7 100644
> --- a/drivers/iio/accel/bmc150-accel-i2c.c
> +++ b/drivers/iio/accel/bmc150-accel-i2c.c
> @@ -1,14 +1,6 @@
>  // SPDX-License-Identifier: GPL-2.0-only
>  /*
> - * 3-axis accelerometer driver supporting following I2C Bosch-Sensortec chips:
> - *  - BMC150
> - *  - BMI055
> - *  - BMA255
> - *  - BMA250E
> - *  - BMA222
> - *  - BMA222E
> - *  - BMA280
> - *
> + * 3-axis accelerometer driver supporting many I2C Bosch-Sensortec chips
>   * Copyright (c) 2014, Intel Corporation.
>   */
>
> --
> 2.32.0
>
Stephan Gerhold June 10, 2021, 12:48 p.m. UTC | #2
On Thu, Jun 10, 2021 at 03:45:17PM +0300, Andy Shevchenko wrote:
> On Thu, Jun 10, 2021 at 3:24 PM Stephan Gerhold <stephan@gerhold.net> wrote:
> >
> > The chips supported by the bmc150-accel driver are clearly documented
> > in Kconfig, in the bmc150_accel_chip_info_tbl as well as in all the
> > device ID tables in the I2C/SPI drivers. It's easy to forget to update
> > the lists in the file header. Drop those entirely to reduce the amount
> > of changes required to add new chip variants.
> >
> > Signed-off-by: Stephan Gerhold <stephan@gerhold.net>
> > ---
> > New patch in v2. Originally I tried to reorder those too but then it
> > caused conflicts in all my following patches so I'm not convinced
> > it's worth to try and keep those up to date.
> 
> It's not user-visible, so I'm fine, but users should have a
> possibility to know about supported chips in the Kconfig option.
> 
> Assuming above is done deal,
> Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
> 

Yep, it's documented in Kconfig already. Actually I even added one
missing chip to Kconfig in patch 4/9 (BMA222) :)

Thanks!
Stephan
diff mbox series

Patch

diff --git a/drivers/iio/accel/bmc150-accel-core.c b/drivers/iio/accel/bmc150-accel-core.c
index a0df704730ee..6fb025b4228f 100644
--- a/drivers/iio/accel/bmc150-accel-core.c
+++ b/drivers/iio/accel/bmc150-accel-core.c
@@ -1,14 +1,6 @@ 
 // SPDX-License-Identifier: GPL-2.0-only
 /*
- * 3-axis accelerometer driver supporting following Bosch-Sensortec chips:
- *  - BMC150
- *  - BMI055
- *  - BMA255
- *  - BMA250E
- *  - BMA222
- *  - BMA222E
- *  - BMA280
- *
+ * 3-axis accelerometer driver supporting many Bosch-Sensortec chips
  * Copyright (c) 2014, Intel Corporation.
  */
 
diff --git a/drivers/iio/accel/bmc150-accel-i2c.c b/drivers/iio/accel/bmc150-accel-i2c.c
index b8bda0dfb495..a0e2782580b7 100644
--- a/drivers/iio/accel/bmc150-accel-i2c.c
+++ b/drivers/iio/accel/bmc150-accel-i2c.c
@@ -1,14 +1,6 @@ 
 // SPDX-License-Identifier: GPL-2.0-only
 /*
- * 3-axis accelerometer driver supporting following I2C Bosch-Sensortec chips:
- *  - BMC150
- *  - BMI055
- *  - BMA255
- *  - BMA250E
- *  - BMA222
- *  - BMA222E
- *  - BMA280
- *
+ * 3-axis accelerometer driver supporting many I2C Bosch-Sensortec chips
  * Copyright (c) 2014, Intel Corporation.
  */