Linux-ACPI Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH 26/33] docs: ABI: convert testing/configfs-acpi to ReST
       [not found] <cover.1603893146.git.mchehab+huawei@kernel.org>
@ 2020-10-28 14:23 ` Mauro Carvalho Chehab
       [not found] ` <4ebaaa0320101479e392ce2db4b62e24fdf15ef1.1603893146.git.mchehab+huawei@kernel.org>
       [not found] ` <95ef2cf3a58f4e50f17d9e58e0d9440ad14d0427.1603893146.git.mchehab+huawei@kernel.org>
  2 siblings, 0 replies; 8+ messages in thread
From: Mauro Carvalho Chehab @ 2020-10-28 14:23 UTC (permalink / raw)
  To: Linux Doc Mailing List, Greg Kroah-Hartman
  Cc: Mauro Carvalho Chehab, Jonathan Corbet, Rafael J. Wysocki,
	Len Brown, linux-acpi, linux-kernel

There are some problems with this file when a ReST content
is produced. Fix it.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/ABI/testing/configfs-acpi | 34 ++++++++++++++++++-------
 1 file changed, 25 insertions(+), 9 deletions(-)

diff --git a/Documentation/ABI/testing/configfs-acpi b/Documentation/ABI/testing/configfs-acpi
index 4ab4e99aa863..c09b640c3cb1 100644
--- a/Documentation/ABI/testing/configfs-acpi
+++ b/Documentation/ABI/testing/configfs-acpi
@@ -14,7 +14,8 @@ Description:
 		This group contains the configuration for user defined ACPI
 		tables. The attributes of a user define table are:
 
-		aml 		- a binary attribute that the user can use to
+		aml
+			      - a binary attribute that the user can use to
 				fill in the ACPI aml definitions. Once the aml
 				data is written to this file and the file is
 				closed the table will be loaded and ACPI devices
@@ -26,11 +27,26 @@ Description:
 		The rest of the attributes are read-only and are valid only
 		after the table has been loaded by filling the aml entry:
 
-		signature 	- ASCII table signature
-		length 		- length of table in bytes, including the header
-		revision 	- ACPI Specification minor version number
-		oem_id 		- ASCII OEM identification
-		oem_table_id 	- ASCII OEM table identification
-		oem_revision 	- OEM revision number
-		asl_compiler_id - ASCII ASL compiler vendor ID
-		asl_compiler_revision - ASL compiler version
+		signature
+				- ASCII table signature
+
+		length
+				- length of table in bytes, including the header
+
+		revision
+				- ACPI Specification minor version number
+
+		oem_id
+				- ASCII OEM identification
+
+		oem_table_id
+				- ASCII OEM table identification
+
+		oem_revision
+				- OEM revision number
+
+		asl_compiler_id
+				- ASCII ASL compiler vendor ID
+
+		asl_compiler_revision
+				- ASL compiler version
-- 
2.26.2


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output
       [not found] ` <4ebaaa0320101479e392ce2db4b62e24fdf15ef1.1603893146.git.mchehab+huawei@kernel.org>
@ 2020-10-28 17:44   ` Richard Cochran
  2020-10-29  7:21     ` Mauro Carvalho Chehab
  2020-10-29 14:49   ` Jonathan Cameron
  2020-11-02 15:06   ` Gautham R Shenoy
  2 siblings, 1 reply; 8+ messages in thread
From: Richard Cochran @ 2020-10-28 17:44 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Greg Kroah-Hartman,
	Mauro Carvalho Chehab, Gautham R. Shenoy, Jason A. Donenfeld,
	Javier González, Jonathan Corbet, Martin K. Petersen,
	Rafael J. Wysocki, Alexander Shishkin, Alexandre Belloni,
	Alexandre Torgue, Andrew Donnellan, Andy Shevchenko, Baolin Wang,
	Benson Leung, Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang,
	Dan Murphy, Dan Williams, Enric Balletbo i Serra,
	Fabrice Gasnier, Felipe Balbi, Frederic Barrat, Guenter Roeck,
	Hanjun Guo, Heikki Krogerus, Jens Axboe, Johannes Thumshirn,
	Jonathan Cameron, Juergen Gross, Konstantin Khlebnikov,
	Kranthi Kuntala, Lakshmi Ramasubramanian, Lars-Peter Clausen,
	Len Brown, Leonid Maksymchuk, Ludovic Desroches,
	Mario Limonciello, Maxime Coquelin, Michael Ellerman,
	Mika Westerberg, Mike Kravetz, Mimi Zohar, Nayna Jain,
	Nicolas Ferre, Niklas Cassel, Oleh Kravchenko, Orson Zhai,
	Pavel Machek, Pawan Gupta, Peter Meerwald-Stadler, Peter Rosin,
	Petr Mladek, Philippe Bergheaud, Sebastian Reichel,
	Sergey Senozhatsky, Stefano Stabellini, Thinh Nguyen,
	Thomas Gleixner, Vineela Tummalapalli, Vishal Verma, linux-acpi,
	linux-arm-kernel, linux-iio, linux-kernel, linux-mm, linux-pm,
	linux-stm32, linux-usb, linuxppc-dev, netdev, xen-devel

On Wed, Oct 28, 2020 at 03:23:18PM +0100, Mauro Carvalho Chehab wrote:

> diff --git a/Documentation/ABI/testing/sysfs-uevent b/Documentation/ABI/testing/sysfs-uevent
> index aa39f8d7bcdf..d0893dad3f38 100644
> --- a/Documentation/ABI/testing/sysfs-uevent
> +++ b/Documentation/ABI/testing/sysfs-uevent
> @@ -19,7 +19,8 @@ Description:
>                  a transaction identifier so it's possible to use the same UUID
>                  value for one or more synthetic uevents in which case we
>                  logically group these uevents together for any userspace
> -                listeners. The UUID value appears in uevent as
> +                listeners. The UUID value appears in uevent as:

I know almost nothing about Sphinx, but why have one colon here ^^^ and ...

> +
>                  "SYNTH_UUID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" environment
>                  variable.
>  
> @@ -30,18 +31,19 @@ Description:
>                  It's possible to define zero or more pairs - each pair is then
>                  delimited by a space character ' '. Each pair appears in
>                  synthetic uevent as "SYNTH_ARG_KEY=VALUE". That means the KEY
> -                name gains "SYNTH_ARG_" prefix to avoid possible collisions
> +                name gains `SYNTH_ARG_` prefix to avoid possible collisions
>                  with existing variables.
>  
> -                Example of valid sequence written to the uevent file:
> +                Example of valid sequence written to the uevent file::

... two here?

Thanks,
Richard

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output
  2020-10-28 17:44   ` [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output Richard Cochran
@ 2020-10-29  7:21     ` Mauro Carvalho Chehab
  0 siblings, 0 replies; 8+ messages in thread
From: Mauro Carvalho Chehab @ 2020-10-29  7:21 UTC (permalink / raw)
  To: Richard Cochran
  Cc: Linux Doc Mailing List, Greg Kroah-Hartman,
	Mauro Carvalho Chehab, Gautham R. Shenoy, Jason A. Donenfeld,
	Javier González, Jonathan Corbet, Martin K. Petersen,
	Rafael J. Wysocki, Alexander Shishkin, Alexandre Belloni,
	Alexandre Torgue, Andrew Donnellan, Andy Shevchenko, Baolin Wang,
	Benson Leung, Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang,
	Dan Murphy, Dan Williams, Enric Balletbo i Serra,
	Fabrice Gasnier, Felipe Balbi, Frederic Barrat, Guenter Roeck,
	Hanjun Guo, Heikki Krogerus, Jens Axboe, Johannes Thumshirn,
	Jonathan Cameron, Juergen Gross, Konstantin Khlebnikov,
	Kranthi Kuntala, Lakshmi Ramasubramanian, Lars-Peter Clausen,
	Len Brown, Leonid Maksymchuk, Ludovic Desroches,
	Mario Limonciello, Maxime Coquelin, Michael Ellerman,
	Mika Westerberg, Mike Kravetz, Mimi Zohar, Nayna Jain,
	Nicolas Ferre, Niklas Cassel, Oleh Kravchenko, Orson Zhai,
	Pavel Machek, Pawan Gupta, Peter Meerwald-Stadler, Peter Rosin,
	Petr Mladek, Philippe Bergheaud, Sebastian Reichel,
	Sergey Senozhatsky, Stefano Stabellini, Thinh Nguyen,
	Thomas Gleixner, Vineela Tummalapalli, Vishal Verma, linux-acpi,
	linux-arm-kernel, linux-iio, linux-kernel, linux-mm, linux-pm,
	linux-stm32, linux-usb, linuxppc-dev, netdev, xen-devel

Hi Richard,

Em Wed, 28 Oct 2020 10:44:27 -0700
Richard Cochran <richardcochran@gmail.com> escreveu:

> On Wed, Oct 28, 2020 at 03:23:18PM +0100, Mauro Carvalho Chehab wrote:
> 
> > diff --git a/Documentation/ABI/testing/sysfs-uevent b/Documentation/ABI/testing/sysfs-uevent
> > index aa39f8d7bcdf..d0893dad3f38 100644
> > --- a/Documentation/ABI/testing/sysfs-uevent
> > +++ b/Documentation/ABI/testing/sysfs-uevent
> > @@ -19,7 +19,8 @@ Description:
> >                  a transaction identifier so it's possible to use the same UUID
> >                  value for one or more synthetic uevents in which case we
> >                  logically group these uevents together for any userspace
> > -                listeners. The UUID value appears in uevent as
> > +                listeners. The UUID value appears in uevent as:  
> 
> I know almost nothing about Sphinx, but why have one colon here ^^^ and ...

Good point. After re-reading the text, this ":" doesn't belong here.

> 
> > +
> >                  "SYNTH_UUID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" environment
> >                  variable.
> >  
> > @@ -30,18 +31,19 @@ Description:
> >                  It's possible to define zero or more pairs - each pair is then
> >                  delimited by a space character ' '. Each pair appears in
> >                  synthetic uevent as "SYNTH_ARG_KEY=VALUE". That means the KEY
> > -                name gains "SYNTH_ARG_" prefix to avoid possible collisions
> > +                name gains `SYNTH_ARG_` prefix to avoid possible collisions
> >                  with existing variables.
> >  
> > -                Example of valid sequence written to the uevent file:
> > +                Example of valid sequence written to the uevent file::  
> 
> ... two here?

The main issue that this patch wants to solve is here:

                This generates synthetic uevent including these variables::

                    ACTION=add
                    SYNTH_ARG_A=1
                    SYNTH_ARG_B=abc
                    SYNTH_UUID=fe4d7c9d-b8c6-4a70-9ef1-3d8a58d18eed

On Sphinx, consecutive lines with the same indent belongs to the same
paragraph. So, without "::", the above will be displayed on a single line,
which is undesired.

using "::" tells Sphinx to display as-is. It will also place it into a a 
box (colored for html output) and using a monospaced font.

The change at the "uevent file:" line was done just for coherency
purposes.

Yet, after re-reading the text, there are other things that are not
coherent. So, I guess the enclosed patch will work better for sys-uevent.

Thanks,
Mauro

docs: ABI: sysfs-uevent: make it compatible with ReST output

- Replace " by ``, in order to use monospaced fonts;
- mark literal blocks as such.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

diff --git a/Documentation/ABI/testing/sysfs-uevent b/Documentation/ABI/testing/sysfs-uevent
index aa39f8d7bcdf..0b6227706b35 100644
--- a/Documentation/ABI/testing/sysfs-uevent
+++ b/Documentation/ABI/testing/sysfs-uevent
@@ -6,42 +6,46 @@ Description:
                 Enable passing additional variables for synthetic uevents that
                 are generated by writing /sys/.../uevent file.
 
-                Recognized extended format is ACTION [UUID [KEY=VALUE ...].
+                Recognized extended format is::
 
-                The ACTION is compulsory - it is the name of the uevent action
-                ("add", "change", "remove"). There is no change compared to
-                previous functionality here. The rest of the extended format
-                is optional.
+			ACTION [UUID [KEY=VALUE ...]
+
+                The ACTION is compulsory - it is the name of the uevent
+                action (``add``, ``change``, ``remove``). There is no change
+                compared to previous functionality here. The rest of the
+                extended format is optional.
 
                 You need to pass UUID first before any KEY=VALUE pairs.
-                The UUID must be in "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+                The UUID must be in ``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``
                 format where 'x' is a hex digit. The UUID is considered to be
                 a transaction identifier so it's possible to use the same UUID
                 value for one or more synthetic uevents in which case we
                 logically group these uevents together for any userspace
                 listeners. The UUID value appears in uevent as
-                "SYNTH_UUID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" environment
+                ``SYNTH_UUID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`` environment
                 variable.
 
                 If UUID is not passed in, the generated synthetic uevent gains
-                "SYNTH_UUID=0" environment variable automatically.
+                ``SYNTH_UUID=0`` environment variable automatically.
 
                 The KEY=VALUE pairs can contain alphanumeric characters only.
+
                 It's possible to define zero or more pairs - each pair is then
                 delimited by a space character ' '. Each pair appears in
-                synthetic uevent as "SYNTH_ARG_KEY=VALUE". That means the KEY
-                name gains "SYNTH_ARG_" prefix to avoid possible collisions
+                synthetic uevent as ``SYNTH_ARG_KEY=VALUE``. That means the KEY
+                name gains ``SYNTH_ARG_`` prefix to avoid possible collisions
                 with existing variables.
 
-                Example of valid sequence written to the uevent file:
+                Example of valid sequence written to the uevent file::
 
                     add fe4d7c9d-b8c6-4a70-9ef1-3d8a58d18eed A=1 B=abc
 
-                This generates synthetic uevent including these variables:
+                This generates synthetic uevent including these variables::
 
                     ACTION=add
                     SYNTH_ARG_A=1
                     SYNTH_ARG_B=abc
                     SYNTH_UUID=fe4d7c9d-b8c6-4a70-9ef1-3d8a58d18eed
+
 Users:
                 udev, userspace tools generating synthetic uevents

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output
       [not found] ` <4ebaaa0320101479e392ce2db4b62e24fdf15ef1.1603893146.git.mchehab+huawei@kernel.org>
  2020-10-28 17:44   ` [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output Richard Cochran
@ 2020-10-29 14:49   ` Jonathan Cameron
  2020-10-30  7:11     ` Mauro Carvalho Chehab
  2020-11-02 15:06   ` Gautham R Shenoy
  2 siblings, 1 reply; 8+ messages in thread
From: Jonathan Cameron @ 2020-10-29 14:49 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Greg Kroah-Hartman,
	Mauro Carvalho Chehab, Gautham R. Shenoy, Jason A. Donenfeld,
	Javier González, Jonathan Corbet, Martin K. Petersen,
	Rafael J. Wysocki, Alexander Shishkin, Alexandre Belloni,
	Alexandre Torgue, Andrew Donnellan, Andy Shevchenko, Baolin Wang,
	Benson Leung, Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang,
	Dan Murphy, Dan Williams, Enric Balletbo i Serra,
	Fabrice Gasnier, Felipe Balbi, Frederic Barrat, Guenter Roeck,
	Hanjun Guo, Heikki Krogerus, Jens Axboe, Johannes Thumshirn,
	Juergen Gross, Konstantin Khlebnikov, Kranthi Kuntala,
	Lakshmi Ramasubramanian, Lars-Peter Clausen, Len Brown,
	Leonid Maksymchuk, Ludovic Desroches, Mario Limonciello,
	Maxime Coquelin, Michael Ellerman, Mika Westerberg, Mike Kravetz,
	Mimi Zohar, Nayna Jain, Nicolas Ferre, Niklas Cassel,
	Oleh Kravchenko, Orson Zhai, Pavel Machek, Pawan Gupta,
	Peter Meerwald-Stadler, Peter Rosin, Petr Mladek,
	Philippe Bergheaud, Richard Cochran, Sebastian Reichel,
	Sergey Senozhatsky, Stefano Stabellini, Thinh Nguyen,
	Thomas Gleixner, Vineela Tummalapalli, Vishal Verma, linux-acpi,
	linux-arm-kernel, linux-iio, linux-kernel, linux-mm, linux-pm,
	linux-stm32, linux-usb, linuxppc-dev, netdev, xen-devel

On Wed, 28 Oct 2020 15:23:18 +0100
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:

> From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> 
> Some files over there won't parse well by Sphinx.
> 
> Fix them.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Query below...  I'm going to guess a rebase issue?

Other than that
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> # for IIO


> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32 b/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32
> index b7259234ad70..a10a4de3e5fe 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32
> @@ -3,67 +3,85 @@ KernelVersion:	4.11
>  Contact:	benjamin.gaignard@st.com
>  Description:
>  		Reading returns the list possible master modes which are:
> -		- "reset"     :	The UG bit from the TIMx_EGR register is
> +
> +
> +		- "reset"
> +				The UG bit from the TIMx_EGR register is
>  				used as trigger output (TRGO).
> -		- "enable"    : The Counter Enable signal CNT_EN is used
> +		- "enable"
> +				The Counter Enable signal CNT_EN is used
>  				as trigger output.
> -		- "update"    : The update event is selected as trigger output.
> +		- "update"
> +				The update event is selected as trigger output.
>  				For instance a master timer can then be used
>  				as a prescaler for a slave timer.
> -		- "compare_pulse" : The trigger output send a positive pulse
> -				    when the CC1IF flag is to be set.
> -		- "OC1REF"    : OC1REF signal is used as trigger output.
> -		- "OC2REF"    : OC2REF signal is used as trigger output.
> -		- "OC3REF"    : OC3REF signal is used as trigger output.
> -		- "OC4REF"    : OC4REF signal is used as trigger output.
> +		- "compare_pulse"
> +				The trigger output send a positive pulse
> +				when the CC1IF flag is to be set.
> +		- "OC1REF"
> +				OC1REF signal is used as trigger output.
> +		- "OC2REF"
> +				OC2REF signal is used as trigger output.
> +		- "OC3REF"
> +				OC3REF signal is used as trigger output.
> +		- "OC4REF"
> +				OC4REF signal is used as trigger output.
> +
>  		Additional modes (on TRGO2 only):
> -		- "OC5REF"    : OC5REF signal is used as trigger output.
> -		- "OC6REF"    : OC6REF signal is used as trigger output.
> +
> +		- "OC5REF"
> +				OC5REF signal is used as trigger output.
> +		- "OC6REF"
> +				OC6REF signal is used as trigger output.
>  		- "compare_pulse_OC4REF":
> -		  OC4REF rising or falling edges generate pulses.
> +				OC4REF rising or falling edges generate pulses.
>  		- "compare_pulse_OC6REF":
> -		  OC6REF rising or falling edges generate pulses.
> +				OC6REF rising or falling edges generate pulses.
>  		- "compare_pulse_OC4REF_r_or_OC6REF_r":
> -		  OC4REF or OC6REF rising edges generate pulses.
> +				OC4REF or OC6REF rising edges generate pulses.
>  		- "compare_pulse_OC4REF_r_or_OC6REF_f":
> -		  OC4REF rising or OC6REF falling edges generate pulses.
> +				OC4REF rising or OC6REF falling edges generate
> +				pulses.
>  		- "compare_pulse_OC5REF_r_or_OC6REF_r":
> -		  OC5REF or OC6REF rising edges generate pulses.
> +				OC5REF or OC6REF rising edges generate pulses.
>  		- "compare_pulse_OC5REF_r_or_OC6REF_f":
> -		  OC5REF rising or OC6REF falling edges generate pulses.
> +				OC5REF rising or OC6REF falling edges generate
> +				pulses.
>  
> -		+-----------+   +-------------+            +---------+
> -		| Prescaler +-> | Counter     |        +-> | Master  | TRGO(2)
> -		+-----------+   +--+--------+-+        |-> | Control +-->
> -		                   |        |          ||  +---------+
> -		                +--v--------+-+ OCxREF ||  +---------+
> -		                | Chx compare +----------> | Output  | ChX
> -		                +-----------+-+         |  | Control +-->
> -		                      .     |           |  +---------+
> -		                      .     |           |    .
> -		                +-----------v-+ OC6REF  |    .
> -		                | Ch6 compare +---------+>
> -		                +-------------+
> +		::
>  
> -		Example with: "compare_pulse_OC4REF_r_or_OC6REF_r":
> +		  +-----------+   +-------------+            +---------+
> +		  | Prescaler +-> | Counter     |        +-> | Master  | TRGO(2)
> +		  +-----------+   +--+--------+-+        |-> | Control +-->
> +		                     |        |          ||  +---------+
> +		                  +--v--------+-+ OCxREF ||  +---------+
> +		                  | Chx compare +----------> | Output  | ChX
> +		                  +-----------+-+         |  | Control +-->
> +		                        .     |           |  +---------+
> +		                        .     |           |    .
> +		                  +-----------v-+ OC6REF  |    .
> +		                  | Ch6 compare +---------+>
> +		                  +-------------+
>  
> -		                X
> -		              X   X
> -		            X .   . X
> -		          X   .   .   X
> -		        X     .   .     X
> -		count X .     .   .     . X
> -		        .     .   .     .
> -		        .     .   .     .
> -		        +---------------+
> -		OC4REF  |     .   .     |
> -		      +-+     .   .     +-+
> -		        .     +---+     .
> -		OC6REF  .     |   |     .
> -		      +-------+   +-------+
> -		        +-+   +-+
> -		TRGO2   | |   | |
> -		      +-+ +---+ +---------+
> +		Example with: "compare_pulse_OC4REF_r_or_OC6REF_r"::
> +
> +		                  X
> +		                X   X
> +		              X .   . X
> +		            X   .   .   X
> +		          X     .   .     X
> +		  count X .     .   .     . X
> +		          .     .   .     .
> +		          .     .   .     .
> +		          +---------------+
> +		  OC4REF  |     .   .     |
> +		        +-+     .   .     +-+
> +		          .     +---+     .
> +		  OC6REF  .     |   |     .
> +		        +-------+   +-------+
> +		          +-+   +-+
> +		  TRGO2   | |   | |
> +		        +-+ +---+ +---------+
>  
>  What:		/sys/bus/iio/devices/triggerX/master_mode
>  KernelVersion:	4.11
> @@ -91,6 +109,30 @@ Description:
>  		When counting down the counter start from preset value
>  		and fire event when reach 0.
>  

Where did these come from?

> +What:		/sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> +KernelVersion:	4.12
> +Contact:	benjamin.gaignard@st.com
> +Description:
> +		Reading returns the list possible quadrature modes.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
> +KernelVersion:	4.12
> +Contact:	benjamin.gaignard@st.com
> +Description:
> +		Configure the device counter quadrature modes:
> +
> +		channel_A:
> +			Encoder A input servers as the count input and B as
> +			the UP/DOWN direction control input.
> +
> +		channel_B:
> +			Encoder B input serves as the count input and A as
> +			the UP/DOWN direction control input.
> +
> +		quadrature:
> +			Encoder A and B inputs are mixed to get direction
> +			and count with a scale of 0.25.
> +
>  What:		/sys/bus/iio/devices/iio:deviceX/in_count_enable_mode_available
>  KernelVersion:	4.12
>  Contact:	benjamin.gaignard@st.com
> @@ -104,6 +146,7 @@ Description:
>  		Configure the device counter enable modes, in all case
>  		counting direction is set by in_count0_count_direction
>  		attribute and the counter is clocked by the internal clock.
> +
>  		always:
>  			Counter is always ON.
>  

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 30/33] docs: ABI: cleanup several ABI documents
       [not found] ` <95ef2cf3a58f4e50f17d9e58e0d9440ad14d0427.1603893146.git.mchehab+huawei@kernel.org>
@ 2020-10-30  6:33   ` Vaibhav Jain
  2020-11-03 15:24   ` Bjorn Andersson
  1 sibling, 0 replies; 8+ messages in thread
From: Vaibhav Jain @ 2020-10-30  6:33 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Linux Doc Mailing List, Greg Kroah-Hartman
  Cc: Andrew Lunn, Peter Chen, Linus Walleij, Jerry Snitselaar,
	dri-devel, Pavel Machek, Christian Gromm, ceph-devel, Kan Liang,
	Bart Van Assche, linux-acpi, Danil Kipnis, Samuel Thibault,
	Guenter Roeck, Ohad Ben-Cohen, linux-pm, Simon Gaiser,
	Avri Altman, Alexander Antonov, Dan Murphy, Thomas Gleixner,
	Stefan Achatz, Konstantin Khlebnikov, Mathieu Malaterre,
	Jingoo Han, Rafael J. Wysocki, linux-kernel, Hans Verkuil,
	Andrew Morton, Wu Hao, Peter Meerwald-Stadler, Mimi Zohar,
	Srinivas Kandagatla, Hanjun Guo, Oleh Kravchenko,
	Lars-Peter Clausen, Andy Shevchenko, Saravana Kannan,
	Gregory CLEMENT, Anton Vorontsov,
	Marek Marczykowski-Górecki, linux-stm32,
	Bartosz Golaszewski, Len Brown, Alexandre Torgue,
	Michael Hennerich, Suzuki K Poulose, coresight, linux-media,
	Frederic, Barrat <fbarrat

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> There are some ABI documents that, while they don't generate
> any warnings, they have issues when parsed by get_abi.pl script
> on its output result.
>
> Address them, in order to provide a clean output.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

<snip>
> diff --git a/Documentation/ABI/testing/sysfs-bus-papr-pmem b/Documentation/ABI/testing/sysfs-bus-papr-pmem
> index c1a67275c43f..8316c33862a0 100644
> --- a/Documentation/ABI/testing/sysfs-bus-papr-pmem
> +++ b/Documentation/ABI/testing/sysfs-bus-papr-pmem
> @@ -11,19 +11,26 @@ Description:
>  		at 'Documentation/powerpc/papr_hcalls.rst' . Below are
>  		the flags reported in this sysfs file:
>  
> -		* "not_armed"	: Indicates that NVDIMM contents will not
> +		* "not_armed"
> +				  Indicates that NVDIMM contents will not
>  				  survive a power cycle.
> -		* "flush_fail"	: Indicates that NVDIMM contents
> +		* "flush_fail"
> +				  Indicates that NVDIMM contents
>  				  couldn't be flushed during last
>  				  shut-down event.
> -		* "restore_fail": Indicates that NVDIMM contents
> +		* "restore_fail"
> +				  Indicates that NVDIMM contents
>  				  couldn't be restored during NVDIMM
>  				  initialization.
> -		* "encrypted"	: NVDIMM contents are encrypted.
> -		* "smart_notify": There is health event for the NVDIMM.
> -		* "scrubbed"	: Indicating that contents of the
> +		* "encrypted"
> +				  NVDIMM contents are encrypted.
> +		* "smart_notify"
> +				  There is health event for the NVDIMM.
> +		* "scrubbed"
> +				  Indicating that contents of the
>  				  NVDIMM have been scrubbed.
> -		* "locked"	: Indicating that NVDIMM contents cant
> +		* "locked"
> +				  Indicating that NVDIMM contents cant
>  				  be modified until next power cycle.
>  
>  What:		/sys/bus/nd/devices/nmemX/papr/perf_stats
> @@ -51,4 +58,4 @@ Description:
>  		* "MedWDur " : Media Write Duration
>  		* "CchRHCnt" : Cache Read Hit Count
>  		* "CchWHCnt" : Cache Write Hit Count
> -		* "FastWCnt" : Fast Write Count
> \ No newline at end of file
> +		* "FastWCnt" : Fast Write Count
<snip>

Thanks,

I am fine with proposed changes to sysfs-bus-papr-pmem.

Acked-by: Vaibhav Jain <vaibhav@linux.ibm.com> # for sysfs-bus-papr-pmem


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output
  2020-10-29 14:49   ` Jonathan Cameron
@ 2020-10-30  7:11     ` Mauro Carvalho Chehab
  0 siblings, 0 replies; 8+ messages in thread
From: Mauro Carvalho Chehab @ 2020-10-30  7:11 UTC (permalink / raw)
  To: Jonathan Cameron
  Cc: Linux Doc Mailing List, Greg Kroah-Hartman,
	Mauro Carvalho Chehab, Gautham R. Shenoy, Jason A. Donenfeld,
	Javier González, Jonathan Corbet, Martin K. Petersen,
	Rafael J. Wysocki, Alexander Shishkin, Alexandre Belloni,
	Alexandre Torgue, Andrew Donnellan, Andy Shevchenko, Baolin Wang,
	Benson Leung, Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang,
	Dan Murphy, Dan Williams, Enric Balletbo i Serra,
	Fabrice Gasnier, Felipe Balbi, Frederic Barrat, Guenter Roeck,
	Hanjun Guo, Heikki Krogerus, Jens Axboe, Johannes Thumshirn,
	Juergen Gross, Konstantin Khlebnikov, Kranthi Kuntala,
	Lakshmi Ramasubramanian, Lars-Peter Clausen, Len Brown,
	Leonid Maksymchuk, Ludovic Desroches, Mario Limonciello,
	Maxime Coquelin, Michael Ellerman, Mika Westerberg, Mike Kravetz,
	Mimi Zohar, Nayna Jain, Nicolas Ferre, Niklas Cassel,
	Oleh Kravchenko, Orson Zhai, Pavel Machek, Pawan Gupta,
	Peter Meerwald-Stadler, Peter Rosin, Petr Mladek,
	Philippe Bergheaud, Richard Cochran, Sebastian Reichel,
	Sergey Senozhatsky, Stefano Stabellini, Thinh Nguyen,
	Thomas Gleixner, Vineela Tummalapalli, Vishal Verma, linux-acpi,
	linux-arm-kernel, linux-iio, linux-kernel, linux-mm, linux-pm,
	linux-stm32, linux-usb, linuxppc-dev, netdev, xen-devel

Em Thu, 29 Oct 2020 14:49:12 +0000
Jonathan Cameron <jic23@kernel.org> escreveu:

> On Wed, 28 Oct 2020 15:23:18 +0100
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> 
> > From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > 
> > Some files over there won't parse well by Sphinx.
> > 
> > Fix them.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>  
> 
> Query below...  I'm going to guess a rebase issue?

Yes. I sent this series about 1,5 years ago. On that time, it
ended by not being merged, as there were too much docs patches
floating around. 

The second SoB is not there on my tree. It was added by
git send-email ;-)

Anyway, fixed.

Thanks,
Mauro

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output
       [not found] ` <4ebaaa0320101479e392ce2db4b62e24fdf15ef1.1603893146.git.mchehab+huawei@kernel.org>
  2020-10-28 17:44   ` [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output Richard Cochran
  2020-10-29 14:49   ` Jonathan Cameron
@ 2020-11-02 15:06   ` Gautham R Shenoy
  2 siblings, 0 replies; 8+ messages in thread
From: Gautham R Shenoy @ 2020-11-02 15:06 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Greg Kroah-Hartman,
	Mauro Carvalho Chehab, Gautham R. Shenoy, Jason A. Donenfeld,
	Javier González, Jonathan Corbet, Martin K. Petersen,
	Rafael J. Wysocki, Alexander Shishkin, Alexandre Belloni,
	Alexandre Torgue, Andrew Donnellan, Andy Shevchenko, Baolin Wang,
	Benson Leung, Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang,
	Dan Murphy, Dan Williams, Enric Balletbo i Serra,
	Fabrice Gasnier, Felipe Balbi, Frederic Barrat, Guenter Roeck,
	Hanjun Guo, Heikki Krogerus, Jens Axboe, Johannes Thumshirn,
	Jonathan Cameron, Juergen Gross, Konstantin Khlebnikov,
	Kranthi Kuntala, Lakshmi Ramasubramanian, Lars-Peter Clausen,
	Len Brown, Leonid Maksymchuk, Ludovic Desroches,
	Mario Limonciello, Maxime Coquelin, Michael Ellerman,
	Mika Westerberg, Mike Kravetz, Mimi Zohar, Nayna Jain,
	Nicolas Ferre, Niklas Cassel, Oleh Kravchenko, Orson Zhai,
	Pavel Machek, Pawan Gupta, Peter Meerwald-Stadler, Peter Rosin,
	Petr Mladek, Philippe Bergheaud, Richard Cochran,
	Sebastian Reichel, Sergey Senozhatsky, Stefano Stabellini,
	Thinh Nguyen, Thomas Gleixner, Vineela Tummalapalli,
	Vishal Verma, linux-acpi, linux-arm-kernel, linux-iio,
	linux-kernel, linux-mm, linux-pm, linux-stm32, linux-usb,
	linuxppc-dev, netdev, xen-devel

On Wed, Oct 28, 2020 at 03:23:18PM +0100, Mauro Carvalho Chehab wrote:
> From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> 
> Some files over there won't parse well by Sphinx.
> 

[..snip..]



> diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu
> index b555df825447..274c337ec6a9 100644
> --- a/Documentation/ABI/testing/sysfs-devices-system-cpu
> +++ b/Documentation/ABI/testing/sysfs-devices-system-cpu
> @@ -151,23 +151,28 @@ Description:
>  		The processor idle states which are available for use have the
>  		following attributes:
> 
> -		name: (RO) Name of the idle state (string).
> +		======== ==== =================================================
> +		name:	 (RO) Name of the idle state (string).
> 
>  		latency: (RO) The latency to exit out of this idle state (in
> -		microseconds).
> +			      microseconds).
> 
> -		power: (RO) The power consumed while in this idle state (in
> -		milliwatts).
> +		power:   (RO) The power consumed while in this idle state (in
> +			      milliwatts).
> 
> -		time: (RO) The total time spent in this idle state (in microseconds).
> +		time:    (RO) The total time spent in this idle state
> +			      (in microseconds).
> 
> -		usage: (RO) Number of times this state was entered (a count).
> +		usage:	 (RO) Number of times this state was entered (a count).
> 
> -		above: (RO) Number of times this state was entered, but the
> -		       observed CPU idle duration was too short for it (a count).
> +		above:	 (RO) Number of times this state was entered, but the
> +			      observed CPU idle duration was too short for it
> +			      (a count).
> 
> -		below: (RO) Number of times this state was entered, but the
> -		       observed CPU idle duration was too long for it (a count).
> +		below: 	 (RO) Number of times this state was entered, but the
> +			      observed CPU idle duration was too long for it
> +			      (a count).
> +		======== ==== =================================================
> 
>  What:		/sys/devices/system/cpu/cpuX/cpuidle/stateN/desc
>  Date:		February 2008
> @@ -290,6 +295,7 @@ Description:	Processor frequency boosting control
>  		This switch controls the boost setting for the whole system.
>  		Boosting allows the CPU and the firmware to run at a frequency
>  		beyound it's nominal limit.
> +
>  		More details can be found in
>  		Documentation/admin-guide/pm/cpufreq.rst
> 

The changes to cpuidle states look good to me.


[..snip..]

> @@ -414,30 +434,30 @@ Description:	POWERNV CPUFreq driver's frequency throttle stats directory and
>  		throttle attributes exported in the 'throttle_stats' directory:
> 
>  		- turbo_stat : This file gives the total number of times the max
> -		frequency is throttled to lower frequency in turbo (at and above
> -		nominal frequency) range of frequencies.
> +		  frequency is throttled to lower frequency in turbo (at and above
> +		  nominal frequency) range of frequencies.
> 
>  		- sub_turbo_stat : This file gives the total number of times the
> -		max frequency is throttled to lower frequency in sub-turbo(below
> -		nominal frequency) range of frequencies.
> +		  max frequency is throttled to lower frequency in sub-turbo(below
> +		  nominal frequency) range of frequencies.
> 
>  		- unthrottle : This file gives the total number of times the max
> -		frequency is unthrottled after being throttled.
> +		  frequency is unthrottled after being throttled.
> 
>  		- powercap : This file gives the total number of times the max
> -		frequency is throttled due to 'Power Capping'.
> +		  frequency is throttled due to 'Power Capping'.
> 
>  		- overtemp : This file gives the total number of times the max
> -		frequency is throttled due to 'CPU Over Temperature'.
> +		  frequency is throttled due to 'CPU Over Temperature'.
> 
>  		- supply_fault : This file gives the total number of times the
> -		max frequency is throttled due to 'Power Supply Failure'.
> +		  max frequency is throttled due to 'Power Supply Failure'.
> 
>  		- overcurrent : This file gives the total number of times the
> -		max frequency is throttled due to 'Overcurrent'.
> +		  max frequency is throttled due to 'Overcurrent'.
> 
>  		- occ_reset : This file gives the total number of times the max
> -		frequency is throttled due to 'OCC Reset'.
> +		  frequency is throttled due to 'OCC Reset'.
> 
>  		The sysfs attributes representing different throttle reasons like
>  		powercap, overtemp, supply_fault, overcurrent and occ_reset map to


This hunk for the powernv cpufreq driver looks good to me.
For these two hunks,

Reviewed-by: Gautham R. Shenoy <ego@linux.vnet.ibm.com>



^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 30/33] docs: ABI: cleanup several ABI documents
       [not found] ` <95ef2cf3a58f4e50f17d9e58e0d9440ad14d0427.1603893146.git.mchehab+huawei@kernel.org>
  2020-10-30  6:33   ` [PATCH 30/33] docs: ABI: cleanup several ABI documents Vaibhav Jain
@ 2020-11-03 15:24   ` Bjorn Andersson
  1 sibling, 0 replies; 8+ messages in thread
From: Bjorn Andersson @ 2020-11-03 15:24 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, coresight, dri-devel, linux-acpi,
	linux-arm-kernel, linux-f2fs-devel, linux-fpga, linux-gpio,
	linux-i3c, linux-iio, linux-kernel, linux-media, linux-pm,
	linux-remoteproc, linux-stm32, linuxppc-dev, netdev

On Wed 28 Oct 09:23 CDT 2020, Mauro Carvalho Chehab wrote:
[..]
>  .../ABI/testing/sysfs-class-remoteproc        |  14 +-

for this:

Acked-by: Bjorn Andersson <bjorn.andersson@linaro.org>

Thanks,
Bjorn

^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, back to index

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [not found] <cover.1603893146.git.mchehab+huawei@kernel.org>
2020-10-28 14:23 ` [PATCH 26/33] docs: ABI: convert testing/configfs-acpi to ReST Mauro Carvalho Chehab
     [not found] ` <4ebaaa0320101479e392ce2db4b62e24fdf15ef1.1603893146.git.mchehab+huawei@kernel.org>
2020-10-28 17:44   ` [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output Richard Cochran
2020-10-29  7:21     ` Mauro Carvalho Chehab
2020-10-29 14:49   ` Jonathan Cameron
2020-10-30  7:11     ` Mauro Carvalho Chehab
2020-11-02 15:06   ` Gautham R Shenoy
     [not found] ` <95ef2cf3a58f4e50f17d9e58e0d9440ad14d0427.1603893146.git.mchehab+huawei@kernel.org>
2020-10-30  6:33   ` [PATCH 30/33] docs: ABI: cleanup several ABI documents Vaibhav Jain
2020-11-03 15:24   ` Bjorn Andersson

Linux-ACPI Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-acpi/0 linux-acpi/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-acpi linux-acpi/ https://lore.kernel.org/linux-acpi \
		linux-acpi@vger.kernel.org
	public-inbox-index linux-acpi

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-acpi


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git