[RFC,00/11] hwmon: Modernize documentation

Message

James Seo May 4, 2023, 7:57 a.m. UTC

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