linux-kernel - Re: [V1 4/4] Documentation ABI: add PPS generators documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <fcc96a91-6ce4-4878-8674-9ee5da062d6d@infradead.org>
Date: Sun, 20 Oct 2024 10:54:24 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Rodolfo Giometti <giometti@...eenne.com>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org
Cc: Andrew Morton <akpm@...ux-foundation.org>, Greg KH <greg@...ah.com>,
 corbet@....net, Hall Christopher S <christopher.s.hall@...el.com>,
 Mohan Subramanian <subramanian.mohan@...el.com>, tglx@...utronix.de,
 andriy.shevchenko@...ux.intel.com, Dong Eddie <eddie.dong@...el.com>,
 N Pandith <pandith.n@...el.com>,
 T R Thejesh Reddy <thejesh.reddy.t.r@...el.com>,
 Zage David <david.zage@...el.com>,
 Chinnadurai Srinivasan <srinivasan.chinnadurai@...el.com>
Subject: Re: [V1 4/4] Documentation ABI: add PPS generators documentation



On 10/18/24 7:39 AM, Rodolfo Giometti wrote:
> This patch adds the documentation for the ABI between the Linux kernel
> and userspace regarding the PPS generators.
> 
> Signed-off-by: Rodolfo Giometti <giometti@...eenne.com>
> ---
>  Documentation/ABI/testing/sysfs-pps-gen | 44 +++++++++++++++++++++++++
>  1 file changed, 44 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-pps-gen
> 

The files "enable", "name", "system", and "time" descriptions are written in
present tense. Preferably change the descriptions for "pps-gen" and "pps-genX"
to present tense also.


> diff --git a/Documentation/ABI/testing/sysfs-pps-gen b/Documentation/ABI/testing/sysfs-pps-gen
> new file mode 100644
> index 000000000000..427ba985f413
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-pps-gen
> @@ -0,0 +1,44 @@
> +What:		/sys/class/pps-gen/
> +Date:		October 2024
> +Contact:	Rodolfo Giometti <giometti@...eenne.com>
> +Description:
> +		The /sys/class/pps-gen/ directory will contain files and

		                                  contains file and

> +		directories that will provide a unified interface to

		            that provide a

> +		the PPS generators.
> +
> +What:		/sys/class/pps-gen/pps-genX/
> +Date:		October 2024
> +Contact:	Rodolfo Giometti <giometti@...eenne.com>
> +Description:
> +		The /sys/class/pps-gen/pps-genX/ directory is related to X-th
> +		PPS generator into the system. Each directory will

		              in the system.
		                               Each directory

> +		contain files to manage and control its PPS generator.

		contains files

> +
> +What:		/sys/class/pps-gen/pps-genX/enable
> +Date:		October 2024
> +Contact:	Rodolfo Giometti <giometti@...eenne.com>
> +Description:
> +		This write-only file enables or disables generation of the
> +		PPS signal.
> +
> +What:		/sys/class/pps-gen/pps-genX/name
> +Date:		October 2024
> +Contact:	Rodolfo Giometti <giometti@...eenne.com>
> +Description:
> +		This read-only file reports the name of the X-th generator.
> +
> +What:		/sys/class/pps-gen/pps-genX/system
> +Date:		October 2024
> +Contact:	Rodolfo Giometti <giometti@...eenne.com>
> +Description:
> +		This read-only file returns "1" if the generator takes the
> +		timing from the system clock, while it returns "0" if not
> +		(i.e. from a peripheral device clock).
> +
> +What:		/sys/class/pps-gen/pps-genX/time
> +Date:		October 2024
> +Contact:	Rodolfo Giometti <giometti@...eenne.com>
> +Description:
> +		This read-only file contains the current time stored into the
> +		generator clock as two integers representing the current time
> +		seconds and nanoseconds.

-- 
~Randy