From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-19.4 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BBC65C43219 for ; Tue, 14 Sep 2021 14:55:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id A7DD26112E for ; Tue, 14 Sep 2021 14:55:31 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234597AbhINO4r (ORCPT ); Tue, 14 Sep 2021 10:56:47 -0400 Received: from mail.kernel.org ([198.145.29.99]:45106 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231816AbhINO4p (ORCPT ); Tue, 14 Sep 2021 10:56:45 -0400 Received: by mail.kernel.org (Postfix) with ESMTPSA id 7B8A960FD7; Tue, 14 Sep 2021 14:55:28 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1631631328; bh=xP0GIfd+EZ5UAddK+nHIS6wuNIEIjdABJRHeANPwTrw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=eLtmU7RKiOMnKM7OQP9iGQJXQnd5aacbttEPuOuWHbgMm2Iw7Ar9GtS/tB+Ora1hD K2yki83IGy/TO4eboTmiFBax4uQk4+sbxgDuxR4krpr9oHfnuA0jUGhD4vSWPJezOJ QAXQ3mAnvCEErxsPmIhEH/N9kZ4sFdB7K6MQiUBnXnnALBVRU53+BaOmejWe+5hEY7 AVnrr2uuCugyidORn81BJhOzEsY03bQ/E/gINNjqdrjHPxwM1YOejmu0sLWfon+Gxx 86vhP6JYm67x44Qd271ak5CTayW/N+o7yoipsNq4pYw6AueGCeMUBAfCIEQIFm9onc mLyesLzjxpX1g== Received: by mail.kernel.org with local (Exim 4.94.2) (envelope-from ) id 1mQ9qI-000L6k-Hr; Tue, 14 Sep 2021 16:55:26 +0200 From: Mauro Carvalho Chehab To: Greg Kroah-Hartman , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , linux-kernel@vger.kernel.org Subject: [PATCH v2 1/8] ABI: stable/sysfs-module: better document modules Date: Tue, 14 Sep 2021 16:55:14 +0200 Message-Id: <9875b31c9c45c0b66600cf929325697222993076.1631630792.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 --- 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