From: "Bence Csókás" <csokas.bence@prolan.hu>
To: Rodolfo Giometti <giometti@enneenne.com>
Cc: linux-kernel@vger.kernel.org,
"Bence Csókás" <csokas.bence@prolan.hu>,
"Rodolfo Giometti" <giometti@linux.it>
Subject: [PATCH] Documentation: sysfs-pps: Fix `Description:`s
Date: Fri, 15 Aug 2025 15:58:29 +0200 [thread overview]
Message-ID: <20250815-b4-sysfs-pps-doc-v1-1-61d315eafbca@prolan.hu> (raw)
It is unnecessary to duplicate `What:` content in the description. It
makes it harder to both read and maintain.
Also, the uapi header no longer lives at `linux/include/linux/pps.h`.
Signed-off-by: Bence Csókás <csokas.bence@prolan.hu>
---
Documentation/ABI/testing/sysfs-pps | 29 ++++++++++++-----------------
Documentation/ABI/testing/sysfs-pps-gen | 2 +-
2 files changed, 13 insertions(+), 18 deletions(-)
diff --git a/Documentation/ABI/testing/sysfs-pps b/Documentation/ABI/testing/sysfs-pps
index 25028c7bc37d8e50a2d4b53d954a2a0628c4a582..b8034ead5ae530c99fcfd280f295057823a3d613 100644
--- a/Documentation/ABI/testing/sysfs-pps
+++ b/Documentation/ABI/testing/sysfs-pps
@@ -10,16 +10,16 @@ What: /sys/class/pps/ppsX/
Date: February 2008
Contact: Rodolfo Giometti <giometti@linux.it>
Description:
- The /sys/class/pps/ppsX/ directory is related to X-th
- PPS source into the system. Each directory will
- contain files to manage and control its PPS source.
+ This directory represents the X-th PPS source in the system.
+ Each directory will contain files to manage and control its
+ PPS source.
What: /sys/class/pps/ppsX/assert
Date: February 2008
Contact: Rodolfo Giometti <giometti@linux.it>
Description:
- The /sys/class/pps/ppsX/assert file reports the assert events
- and the assert sequence number of the X-th source in the form:
+ This file reports the assert events and the assert sequence
+ number in the form:
<secs>.<nsec>#<sequence>
@@ -30,8 +30,8 @@ What: /sys/class/pps/ppsX/clear
Date: February 2008
Contact: Rodolfo Giometti <giometti@linux.it>
Description:
- The /sys/class/pps/ppsX/clear file reports the clear events
- and the clear sequence number of the X-th source in the form:
+ This file reports the clear events and the clear sequence
+ number in the form:
<secs>.<nsec>#<sequence>
@@ -42,32 +42,27 @@ What: /sys/class/pps/ppsX/mode
Date: February 2008
Contact: Rodolfo Giometti <giometti@linux.it>
Description:
- The /sys/class/pps/ppsX/mode file reports the functioning
- mode of the X-th source in hexadecimal encoding.
+ This file reports the mode bits in hexadecimal encoding.
- Please, refer to linux/include/linux/pps.h for further
- info.
+ Please refer to <linux/pps.h> for further info.
What: /sys/class/pps/ppsX/echo
Date: February 2008
Contact: Rodolfo Giometti <giometti@linux.it>
Description:
- The /sys/class/pps/ppsX/echo file reports if the X-th does
- or does not support an "echo" function.
+ Whether this source supports an "echo" function.
What: /sys/class/pps/ppsX/name
Date: February 2008
Contact: Rodolfo Giometti <giometti@linux.it>
Description:
- The /sys/class/pps/ppsX/name file reports the name of the
- X-th source.
+ The name of the PPS source.
What: /sys/class/pps/ppsX/path
Date: February 2008
Contact: Rodolfo Giometti <giometti@linux.it>
Description:
- The /sys/class/pps/ppsX/path file reports the path name of
- the device connected with the X-th source.
+ The path name of the device connected to this source.
If the source is not connected with any device the content
of this file is empty.
diff --git a/Documentation/ABI/testing/sysfs-pps-gen b/Documentation/ABI/testing/sysfs-pps-gen
index 2519207b88fdffdc404238409cb03d0112ce1958..c36bac37a883f1d702ff97e63603d4df7e24de83 100644
--- a/Documentation/ABI/testing/sysfs-pps-gen
+++ b/Documentation/ABI/testing/sysfs-pps-gen
@@ -12,7 +12,7 @@ Date: February 2025
KernelVersion: 6.13
Contact: Rodolfo Giometti <giometti@enneenne.com>
Description:
- The /sys/class/pps-gen/pps-genX/ directory is related to X-th
+ This directory represents the X-th
PPS generator in the system. Each directory contain files to
manage and control its PPS generator.
---
base-commit: 88250d40ed59d2b3c2dff788e9065caa7eb4dba0
change-id: 20250815-b4-sysfs-pps-doc-270e54da51b4
Best regards,
--
Bence Csókás <csokas.bence@prolan.hu>
next reply other threads:[~2025-08-15 13:58 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-15 13:58 Bence Csókás [this message]
2025-08-15 14:09 ` Rodolfo Giometti
2025-09-15 15:29 ` Csókás Bence
2025-10-08 21:11 ` Bence Csókás
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250815-b4-sysfs-pps-doc-v1-1-61d315eafbca@prolan.hu \
--to=csokas.bence@prolan.hu \
--cc=giometti@enneenne.com \
--cc=giometti@linux.it \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®