Received: by 2002:a05:6a11:4021:0:0:0:0 with SMTP id ky33csp3982623pxb; Mon, 27 Sep 2021 07:02:29 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwZr0z/3+waVgPKip3ItQGA8b87IeRQfhQebfIpdKgV95TkgUYQ8vP709QFpRSOr7Y9HAdi X-Received: by 2002:a17:906:4ccf:: with SMTP id q15mr207394ejt.9.1632751348936; Mon, 27 Sep 2021 07:02:28 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1632751348; cv=none; d=google.com; s=arc-20160816; b=eDe5iykOsU4gXL2vLSD4GQesvan2B7UkMoqNq4dXP4NF0utIESd7DPvdDQ6zojZ/zc KKVipFQQ2Tu7Imn+wkrtFOM568cJ1x75XhBkk7a0DIkOlx07E+bZ3QzNGo0eh5yen7uF Qq4u7uhtpAvXps1XakgIecswnsykeVANba5thFGSQfFyUZMaEX1fH0LGFu92tvDL00z6 rUZUKohFarPP3wZGkUamLlyl7Pxez5C5eIXZtDs7J5N6112UM9W2oLFWGPCc/1Xo+fel 3oniWkuMVXIpmnsgohLL+yadJXVIWSFEW8shlbUnPZ8RW9ZEvc+wqatuX3NVDRDGtYZ2 v20g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=uyM8yFqsJLxA1NvTNaGqj0w6t22d6X2IFRjwNWGjT1k=; b=fGgg8HGcnURe6Zt2WI3Hz3WKzXlOFuZwlA1uExXaqUg78aJoe11CyHGZ3KRn4PbIBH UA47VPkINTQU5bRBhOv5LFoYeFmxUjuqUto19DkRQJRL61khxX25R9rgNGgPh0H5c0us ScFl63Mbc6oh6ju9DF5EWd6EYnZI7CERSzbk7ag+vyru3fakcSsahGa48vAMvoJlqLQF MC0qOAzf0Yjurg5NuwIXOxCpMcb/SEu9Co/Kpr901HZQ9ddb4+TJEwEIpX8ZlPhRrlJX FgC2TNuWJCbOpirsoAnVa08XdkxkeruX2Uy4k8dyV5+N1g7ALcOnGJWHX+GwEdNhQTko B+zw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=A0vKUaz5; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id ka17si18594838ejc.609.2021.09.27.07.02.02; Mon, 27 Sep 2021 07:02:28 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=A0vKUaz5; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234813AbhI0OBr (ORCPT + 99 others); Mon, 27 Sep 2021 10:01:47 -0400 Received: from mail.kernel.org ([198.145.29.99]:47982 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234704AbhI0OBf (ORCPT ); Mon, 27 Sep 2021 10:01:35 -0400 Received: by mail.kernel.org (Postfix) with ESMTPSA id 49A8A610A2; Mon, 27 Sep 2021 13:59:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1632751197; bh=JSJGD8oEtr4UgVNxX4nTLt/BvMiQeGS7fW3nJC9PfHQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=A0vKUaz5FtH5vI9VuGPWauA82jY05IzDAg8jcZvx46YnD5FnY0u3DCvuQhWi7ZlRL 7C2FDDA0WP/CyN4GzGQoKfc2UqWLHtpbmSRnSkkvW1uzaqkRLd4AMUzz56uJAeOU+w 97VfpOXhBctYEEZQMLi0QwkzFx0FMEfvr5uS4GIJlkXLrcfnffhd6EeZg3G3gsJcjg gceAnm9oixMQQ703pe23KCFo5EiBHcag7vAYdDLInn6SdswB7HdviOwzXIdytkrK8y Nrz1Z3b+nmjP/q344St1utX17jnjsicd1ZyvHXqwJ550Ok78We1+1P8CyEX46eQOjk 5yYm2iIT6jdUQ== Received: by mail.kernel.org with local (Exim 4.94.2) (envelope-from ) id 1mUrAh-000Ata-8i; Mon, 27 Sep 2021 15:59:55 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , Greg Kroah-Hartman Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , linux-kernel@vger.kernel.org Subject: [PATCH 01/17] ABI: stable/sysfs-module: better document modules Date: Mon, 27 Sep 2021 15:59:34 +0200 Message-Id: <35876c1eabbcd03170d658081030db980b403297.1632750608.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.31.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Instead of placing almost everything there as a text, use the proper What: for each component of the ABI. This allows it to be better documented and parsed by get_abi.pl. While here, use wildcards for MODULENAME. Signed-off-by: Mauro Carvalho Chehab --- See [PATCH 00/17] at: https://lore.kernel.org/all/cover.1632750608.git.mchehab+huawei@kernel.org/ Documentation/ABI/stable/sysfs-module | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/Documentation/ABI/stable/sysfs-module b/Documentation/ABI/stable/sysfs-module index 6272ae5fb366..5c028af9921a 100644 --- a/Documentation/ABI/stable/sysfs-module +++ b/Documentation/ABI/stable/sysfs-module @@ -1,8 +1,7 @@ -What: /sys/module -Description: - The /sys/module tree consists of the following structure: +The /sys/module tree consists of the following structure: - /sys/module/MODULENAME +What: /sys/module/ +Description: The name of the module that is in the kernel. This module name will always show up if the module is loaded as a dynamic module. If it is built directly into the kernel, it @@ -12,7 +11,8 @@ Description: Note: The conditions of creation in the built-in case are not by design and may be removed in the future. - /sys/module/MODULENAME/parameters +What: /sys/module//parameters +Description: This directory contains individual files that are each individual parameters of the module that are able to be changed at runtime. See the individual module @@ -25,7 +25,8 @@ Description: individual driver documentation for details as to the stability of the different parameters. - /sys/module/MODULENAME/refcnt +What: /sys/module//refcnt +Description: If the module is able to be unloaded from the kernel, this file will contain the current reference count of the module. -- 2.31.1