From nobody Tue Dec 16 07:57:33 2025 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8FAFDF9D9; Sun, 14 Dec 2025 20:26:03 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1765743964; cv=none; b=om0xaqqqrNyMGi0DWx1FwIgMP+EZ5PHes9J/mQYorV8ncnLTFBrh/K8qnDakyN6oXLHsn5x58xjWYUFD2rVr9gUFNmjj2DjGhptMQTbO8diBAC5Jjom7/YtVX+95gIOVZXMr7qTYcMPuUxGbKpSHGQ1BS8Nul2cbJFndKeKqbjU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1765743964; c=relaxed/simple; bh=bWHnczMX4V5FFiTIRvdFJn7prFk6Q9CLUjOr8uJdIBA=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=IiYNN6oQ5pw4nuafdjgZgoaoroSWOXO/GjoMS1R2JpX7htHTQEinP3s7mTDRVszHzu06/iKjwc1vOT3hxjS1oAeRQoxiqgBdf772soL1XuY+qN2PC8u28Rv7kXxz9Y0PuqlD37aMwuxkVXWWKJ+eMJUp+mm6PzRiABXCRDcSoM8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=QLXTib8U; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="QLXTib8U" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=K19pLdafFW741s/Kto9uQWN4sauI7vl0PzvVNTSPNBw=; b=QLXTib8UKvywdy1gVkmiHfz15f Jloj6lwo0SzBoDXUaqb3nBrdUJs9i418uqLVQqx6yodJTJFInlphMUkO6jwduzkptHrVD+m6PgrUX ZehsQbgN+jXuSMEMbx+TtfKlLC3qyaDPJkFNnetXPBthjB39FgkNiOuyyIBnoIjxT41bJKoyGa+V3 oabCeZ53aNVsUYTkvlB1WWxlDBQiR702tgKkZCRjgfxMDUC0whM5Zsc3zux5B7wcJlBuxxDlj24T4 Y9kHtHepCiBL35FUMuIR4Aj7Gz+jQp6bKQ0MEkkouQbUByUpGsVUwcjmsvIPQjpkhr+qSyYuyXR9g zDB++4lg==; Received: from [50.53.43.113] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.98.2 #2 (Red Hat Linux)) id 1vUsfL-00000002iWz-0LXq; Sun, 14 Dec 2025 20:26:03 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Luis Chamberlain , Petr Pavlu , Daniel Gomez , linux-modules@vger.kernel.org Subject: [PATCH] modules: moduleparam.h: add kernel-doc comments Date: Sun, 14 Dec 2025 12:26:00 -0800 Message-ID: <20251214202600.2212699-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.52.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add missing kernel-doc comments to prevent kernel-doc warnings: Warning: include/linux/moduleparam.h:364 function parameter 'arg' not described in '__core_param_cb' Warning: include/linux/moduleparam.h:395 No description found for return value of 'parameq' Warning: include/linux/moduleparam.h:405 No description found for return value of 'parameqn' Signed-off-by: Randy Dunlap --- Cc: Luis Chamberlain Cc: Petr Pavlu Cc: Daniel Gomez Cc: linux-modules@vger.kernel.org --- include/linux/moduleparam.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) --- linux-next-20251203.orig/include/linux/moduleparam.h +++ linux-next-20251203/include/linux/moduleparam.h @@ -355,8 +355,8 @@ static inline void kernel_param_unlock(s /** * __core_param_cb - similar like core_param, with a set/get ops instead o= f type. * @name: the name of the cmdline and sysfs parameter (often the same as v= ar) - * @var: the variable * @ops: the set & get operations for this parameter. + * @arg: the variable * @perm: visibility in sysfs * * Ideally this should be called 'core_param_cb', but the name has been @@ -390,7 +390,7 @@ static inline void kernel_param_unlock(s * @name1: parameter name 1 * @name2: parameter name 2 * - * Returns true if the two parameter names are equal. + * Returns: true if the two parameter names are equal. * Dashes (-) are considered equal to underscores (_). */ extern bool parameq(const char *name1, const char *name2); @@ -402,6 +402,10 @@ extern bool parameq(const char *name1, c * @n: the length to compare * * Similar to parameq(), except it compares @n characters. + * + * Returns: true if the first @n characters of the two parameter names + * are equal. + * Dashes (-) are considered equal to underscores (_). */ extern bool parameqn(const char *name1, const char *name2, size_t n);