From: James Seo <james@equiv.tech>
To: Jean Delvare <jdelvare@suse.com>,
Guenter Roeck <linux@roeck-us.net>,
Jonathan Corbet <corbet@lwn.net>
Cc: James Seo <james@equiv.tech>,
linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [RFC 00/11] hwmon: Modernize documentation
Date: Thu, 4 May 2023 00:57:41 -0700 [thread overview]
Message-ID: <20230504075752.1320967-1-james@equiv.tech> (raw)
To help summon the beautifully documented kernel of the future
promised by the move to ReST, this series revises the hwmon subsystem
documentation to make it more comprehensive and internally consistent.
The latter goal also requires a few API and ABI additions that should
have been in tree but weren't.
James Seo (11):
Documentation/hwmon: Move misplaced entry in hwmon docs index
hwmon: (core) Rename last parameter of devm_hwmon_register_with_info()
hwmon: (core) Revise kerneldoc comments
Documentation/hwmon: Revise hwmon kernel API reference
Documentation/hwmon: Revise PMBus core documentation
Documentation/hwmon: Revise patch submission checklist
Documentation/hwmon: Revise sysfs interface specification
Documentation/hwmon: Revise userspace tools documentation
ABI: sysfs-class-hwmon: Revise hwmon ABI documentation
hwmon: (core) Add missing beep-related standard attributes
ABI: sysfs-class-hwmon: Add missing hwmon standard attributes
Documentation/ABI/testing/sysfs-class-hwmon | 901 +++++++++++++-----
Documentation/hwmon/hwmon-kernel-api.rst | 740 ++++++++-------
Documentation/hwmon/index.rst | 2 +-
Documentation/hwmon/pmbus-core.rst | 348 ++++---
Documentation/hwmon/submitting-patches.rst | 110 +--
Documentation/hwmon/sysfs-interface.rst | 984 +++++++++-----------
Documentation/hwmon/userspace-tools.rst | 129 ++-
drivers/hwmon/hwmon.c | 169 ++--
include/linux/hwmon-sysfs.h | 19 +-
include/linux/hwmon.h | 90 +-
10 files changed, 2037 insertions(+), 1455 deletions(-)
base-commit: 1a5304fecee523060f26e2778d9d8e33c0562df3
--
2.34.1
next reply other threads:[~2023-05-04 8:26 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-04 7:57 James Seo [this message]
2023-05-04 7:57 ` [RFC 01/11] Documentation/hwmon: Move misplaced entry in hwmon docs index James Seo
2023-05-05 4:58 ` Bagas Sanjaya
2023-05-06 13:43 ` Guenter Roeck
2023-05-04 7:57 ` [RFC 02/11] hwmon: (core) Rename last parameter of devm_hwmon_register_with_info() James Seo
2023-05-04 15:29 ` Guenter Roeck
2023-05-05 13:15 ` James Seo
2023-05-05 13:30 ` Guenter Roeck
2023-05-05 14:39 ` James Seo
2023-05-04 7:57 ` [RFC 03/11] hwmon: (core) Revise kerneldoc comments James Seo
2023-07-25 23:51 ` Russell Haley
2023-05-04 7:57 ` [RFC 04/11] Documentation/hwmon: Revise hwmon kernel API reference James Seo
2023-05-05 4:12 ` Bagas Sanjaya
2023-05-05 4:20 ` Bagas Sanjaya
2023-05-05 13:29 ` James Seo
2023-05-06 13:52 ` Guenter Roeck
2023-05-07 14:40 ` James Seo
2023-05-04 7:57 ` [RFC 05/11] Documentation/hwmon: Revise PMBus core documentation James Seo
2023-05-05 4:27 ` Bagas Sanjaya
2023-05-05 4:32 ` Guenter Roeck
2023-05-05 13:35 ` James Seo
2023-05-04 7:57 ` [RFC 06/11] Documentation/hwmon: Revise patch submission checklist James Seo
2023-05-05 4:34 ` Bagas Sanjaya
2023-05-05 14:50 ` James Seo
2023-05-04 7:57 ` [RFC 07/11] Documentation/hwmon: Revise sysfs interface specification James Seo
2023-05-05 4:51 ` Bagas Sanjaya
2023-05-05 15:01 ` James Seo
2023-05-05 15:10 ` Jonathan Corbet
2023-05-04 7:57 ` [RFC 08/11] Documentation/hwmon: Revise userspace tools documentation James Seo
2023-05-05 5:03 ` Bagas Sanjaya
2023-05-05 15:12 ` James Seo
2023-05-05 21:10 ` Guenter Roeck
2023-05-04 7:57 ` [RFC 09/11] ABI: sysfs-class-hwmon: Revise hwmon ABI documentation James Seo
2023-05-04 7:57 ` [RFC 10/11] hwmon: (core) Add missing beep-related standard attributes James Seo
2023-05-04 7:57 ` [RFC 11/11] ABI: sysfs-class-hwmon: Add missing hwmon " James Seo
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=20230504075752.1320967-1-james@equiv.tech \
--to=james@equiv.tech \
--cc=corbet@lwn.net \
--cc=jdelvare@suse.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
/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
Powered by JetHome