diff mbox series

[RFC,5/7] iio:ABI docs: Combine sysfs-bus-iio-humidity-hdc2010/hdc100x into one file

Message ID 20210117153816.696693-6-jic23@kernel.org (mailing list archive)
State New
Headers show
Series IIO ABI documentation duplication fixes | expand

Commit Message

Jonathan Cameron Jan. 17, 2021, 3:38 p.m. UTC
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

These contain only one entry for out_current_heater_raw (_available).
Document this in a new sysfs-bus-iio-humidity file, and make it a little
more generic by allowing for non 0/1 values.

Fixes:
$ scripts/get_abi.pl validate
Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times:  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times:  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1

Cc: Eugene Zaikonnikov <ez@norphonic.com>
Cc: Matt Ranostay <matt.ranostay@konsulko.com>
Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
---
 ...s-bus-iio-humidity-hdc2010 => sysfs-bus-iio-humidity} | 3 ++-
 Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x | 9 ---------
 2 files changed, 2 insertions(+), 10 deletions(-)

Comments

Matt Ranostay Jan. 17, 2021, 11:12 p.m. UTC | #1
On Sun, Jan 17, 2021 at 7:40 AM Jonathan Cameron <jic23@kernel.org> wrote:
>
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> These contain only one entry for out_current_heater_raw (_available).
> Document this in a new sysfs-bus-iio-humidity file, and make it a little
> more generic by allowing for non 0/1 values.
>
> Fixes:
> $ scripts/get_abi.pl validate
> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times:  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times:  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
>
> Cc: Eugene Zaikonnikov <ez@norphonic.com>
> Cc: Matt Ranostay <matt.ranostay@konsulko.com>
> Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Reviewed-by: Matt Ranostay <matt.ranostay@konsulko.com>

> ---
>  ...s-bus-iio-humidity-hdc2010 => sysfs-bus-iio-humidity} | 3 ++-
>  Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x | 9 ---------
>  2 files changed, 2 insertions(+), 10 deletions(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010 b/Documentation/ABI/testing/sysfs-bus-iio-humidity
> similarity index 79%
> rename from Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010
> rename to Documentation/ABI/testing/sysfs-bus-iio-humidity
> index 5b78af5f341d..cb0d7e75d297 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-humidity
> @@ -6,4 +6,5 @@ Description:
>                 Controls the heater device within the humidity sensor to get
>                 rid of excess condensation.
>
> -               Valid control values are 0 = OFF, and 1 = ON.
> +               In some devices, this is just a switch in which case 0 = OFF,
> +               and 1 = ON.
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x b/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x
> deleted file mode 100644
> index b72bb62552cf..000000000000
> --- a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x
> +++ /dev/null
> @@ -1,9 +0,0 @@
> -What:          /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw
> -What:          /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available
> -KernelVersion: 4.3
> -Contact:       linux-iio@vger.kernel.org
> -Description:
> -               Controls the heater device within the humidity sensor to get
> -               rid of excess condensation.
> -
> -               Valid control values are 0 = OFF, and 1 = ON.
> --
> 2.30.0
>
Jonathan Cameron Feb. 21, 2021, 4:08 p.m. UTC | #2
On Sun, 17 Jan 2021 15:12:40 -0800
Matt Ranostay <matt.ranostay@konsulko.com> wrote:

> On Sun, Jan 17, 2021 at 7:40 AM Jonathan Cameron <jic23@kernel.org> wrote:
> >
> > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> >
> > These contain only one entry for out_current_heater_raw (_available).
> > Document this in a new sysfs-bus-iio-humidity file, and make it a little
> > more generic by allowing for non 0/1 values.
> >
> > Fixes:
> > $ scripts/get_abi.pl validate
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times:  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times:  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1  ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
> >
> > Cc: Eugene Zaikonnikov <ez@norphonic.com>
> > Cc: Matt Ranostay <matt.ranostay@konsulko.com>
> > Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>  
> 
> Reviewed-by: Matt Ranostay <matt.ranostay@konsulko.com>
Applied, thanks

J
> 
> > ---
> >  ...s-bus-iio-humidity-hdc2010 => sysfs-bus-iio-humidity} | 3 ++-
> >  Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x | 9 ---------
> >  2 files changed, 2 insertions(+), 10 deletions(-)
> >
> > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010 b/Documentation/ABI/testing/sysfs-bus-iio-humidity
> > similarity index 79%
> > rename from Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010
> > rename to Documentation/ABI/testing/sysfs-bus-iio-humidity
> > index 5b78af5f341d..cb0d7e75d297 100644
> > --- a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010
> > +++ b/Documentation/ABI/testing/sysfs-bus-iio-humidity
> > @@ -6,4 +6,5 @@ Description:
> >                 Controls the heater device within the humidity sensor to get
> >                 rid of excess condensation.
> >
> > -               Valid control values are 0 = OFF, and 1 = ON.
> > +               In some devices, this is just a switch in which case 0 = OFF,
> > +               and 1 = ON.
> > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x b/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x
> > deleted file mode 100644
> > index b72bb62552cf..000000000000
> > --- a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x
> > +++ /dev/null
> > @@ -1,9 +0,0 @@
> > -What:          /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw
> > -What:          /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available
> > -KernelVersion: 4.3
> > -Contact:       linux-iio@vger.kernel.org
> > -Description:
> > -               Controls the heater device within the humidity sensor to get
> > -               rid of excess condensation.
> > -
> > -               Valid control values are 0 = OFF, and 1 = ON.
> > --
> > 2.30.0
> >
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010 b/Documentation/ABI/testing/sysfs-bus-iio-humidity
similarity index 79%
rename from Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010
rename to Documentation/ABI/testing/sysfs-bus-iio-humidity
index 5b78af5f341d..cb0d7e75d297 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010
+++ b/Documentation/ABI/testing/sysfs-bus-iio-humidity
@@ -6,4 +6,5 @@  Description:
 		Controls the heater device within the humidity sensor to get
 		rid of excess condensation.
 
-		Valid control values are 0 = OFF, and 1 = ON.
+		In some devices, this is just a switch in which case 0 = OFF,
+		and 1 = ON.
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x b/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x
deleted file mode 100644
index b72bb62552cf..000000000000
--- a/Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x
+++ /dev/null
@@ -1,9 +0,0 @@ 
-What:		/sys/bus/iio/devices/iio:deviceX/out_current_heater_raw
-What:		/sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available
-KernelVersion:	4.3
-Contact:	linux-iio@vger.kernel.org
-Description:
-		Controls the heater device within the humidity sensor to get
-		rid of excess condensation.
-
-		Valid control values are 0 = OFF, and 1 = ON.