From patchwork Thu May 4 07:57:41 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: James Seo X-Patchwork-Id: 13230919 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id E68ECC7EE21 for ; Thu, 4 May 2023 08:26:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229963AbjEDI0V (ORCPT ); Thu, 4 May 2023 04:26:21 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35628 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229965AbjEDIZX (ORCPT ); Thu, 4 May 2023 04:25:23 -0400 Received: from m228-4.mailgun.net (m228-4.mailgun.net [159.135.228.4]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 003866182 for ; Thu, 4 May 2023 01:18:53 -0700 (PDT) DKIM-Signature: a=rsa-sha256; v=1; c=relaxed/relaxed; d=equiv.tech; q=dns/txt; s=mx; t=1683188332; x=1683195532; h=Content-Transfer-Encoding: MIME-Version: Message-Id: Date: Subject: Subject: Cc: To: To: From: From: Sender: Sender; bh=ms3njcBQrrmRVxxbQssJjnY8BrYOrndinPX9QZIyRxU=; b=kVI/kK/cfVePXyfKN8F3nT/QhFQZMufJcfyrNWHv4dgN0yLGa2fvNLrcEkiFiXbwMG9d9h1uNeU18yZZGijprmaHPepI45RgPYOpXhSV2C/L9CVKf8Bdl4iXk34i4dALQH0Sifx1pXWfokmULXXehdpWtSEmpWNmd97DN7nkJw5ploN0BS0Ex0lvy0ektW98S0mmGJc90/3T4zbdjV60u0WovGZpWjPoP/OUcD1SZAop6a/BuSw7W5D17JS4cBwmc0jctnc8/Odfbj4vW3Dtua9LsMUt0ZXV91DJEdne+x6UAPycsd3Me2omdU+B37YTCD5V71pUt1DzMxS31TGYsQ== X-Mailgun-Sending-Ip: 159.135.228.4 X-Mailgun-Sid: WyJkOWUwNSIsImxpbnV4LWh3bW9uQHZnZXIua2VybmVsLm9yZyIsIjkzZDVhYiJd Received: from mail.equiv.tech (equiv.tech [142.93.28.83]) by f7d08f3fa3fc with SMTP id 6453659de31b292e1ff52a9b (version=TLS1.2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256); Thu, 04 May 2023 07:58:21 GMT Sender: james@equiv.tech From: James Seo To: Jean Delvare , Guenter Roeck , Jonathan Corbet Cc: James Seo , 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 Message-Id: <20230504075752.1320967-1-james@equiv.tech> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-hwmon@vger.kernel.org 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