diff mbox series

[RFC,v3,11/11] ABI: pps: Add ABI documentation for Intel TIO

Message ID 20240103115602.19044-12-lakshmi.sowjanya.d@intel.com (mailing list archive)
State RFC
Headers show
Series Add support for Intel PPS Generator | expand

Commit Message

D, Lakshmi Sowjanya Jan. 3, 2024, 11:56 a.m. UTC
From: Lakshmi Sowjanya D <lakshmi.sowjanya.d@intel.com>

Document sysfs interface for Intel Timed I/O PPS driver

Signed-off-by: Lakshmi Sowjanya D <lakshmi.sowjanya.d@intel.com>
---
 Documentation/ABI/testing/sysfs-platform-pps-tio | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-platform-pps-tio

Comments

Paul Menzel Jan. 4, 2024, 12:24 a.m. UTC | #1
Dear Lakshmi,


Thank you for your patch.

Am 03.01.24 um 12:56 schrieb lakshmi.sowjanya.d@intel.com:
> From: Lakshmi Sowjanya D <lakshmi.sowjanya.d@intel.com>
> 
> Document sysfs interface for Intel Timed I/O PPS driver

I’d add a dot/period at the end.

> Signed-off-by: Lakshmi Sowjanya D <lakshmi.sowjanya.d@intel.com>
> ---
>   Documentation/ABI/testing/sysfs-platform-pps-tio | 7 +++++++
>   1 file changed, 7 insertions(+)
>   create mode 100644 Documentation/ABI/testing/sysfs-platform-pps-tio
> 
> diff --git a/Documentation/ABI/testing/sysfs-platform-pps-tio b/Documentation/ABI/testing/sysfs-platform-pps-tio
> new file mode 100644
> index 000000000000..24a2eb591a05
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-platform-pps-tio
> @@ -0,0 +1,7 @@
> +What:		/sys/devices/platform/INTCxxxx/enable
> +Date:		March 2024
> +KernelVersion	6.9
> +Contact:	Lakshmi Sowjanya D <lakshmi.sowjanya.d@intel.com>
> +Description:
> +		(RW) Enable or disable PPS TIO generator output, read to
> +		see the status of hardware(Enabled/Disabled).

Please add a space before the (.

Wouldn’t it be more intuitive, if it returned true/false?


Kind regards,

Paul
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-platform-pps-tio b/Documentation/ABI/testing/sysfs-platform-pps-tio
new file mode 100644
index 000000000000..24a2eb591a05
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-platform-pps-tio
@@ -0,0 +1,7 @@ 
+What:		/sys/devices/platform/INTCxxxx/enable
+Date:		March 2024
+KernelVersion	6.9
+Contact:	Lakshmi Sowjanya D <lakshmi.sowjanya.d@intel.com>
+Description:
+		(RW) Enable or disable PPS TIO generator output, read to
+		see the status of hardware(Enabled/Disabled).