| Message ID | 20231215001513.work.563-kees@kernel.org |
|---|---|
| State | New |
| Headers |
Return-Path: <linux-kernel+bounces-279-ouuuleilei=gmail.com@vger.kernel.org>
Delivered-To: ouuuleilei@gmail.com
Received: by 2002:a05:7300:3b04:b0:fb:cd0c:d3e with SMTP id c4csp8940589dys;
Thu, 14 Dec 2023 16:15:39 -0800 (PST)
X-Google-Smtp-Source:
AGHT+IGse7FpEWA4Z1Omm8XXTaSHL9jcWZYBUDeyuHPXJI35SGK1IkuZtosLX2VjM7ml2oThgr8A
X-Received: by 2002:a92:680b:0:b0:35d:5dcb:7558 with SMTP id
d11-20020a92680b000000b0035d5dcb7558mr11923254ilc.60.1702599339026;
Thu, 14 Dec 2023 16:15:39 -0800 (PST)
ARC-Seal: i=1; a=rsa-sha256; t=1702599338; cv=none;
d=google.com; s=arc-20160816;
b=yvuZ0G/A6iS3xnuFXo+0hd4K5ac0gR+9m0aj7DYb/vYQYhSlpjzx+eSaX63aItTHzJ
HUpJ0z6TNQTI3dw4fJds14u9SXpq8liIjTQX+84BZD7r5KqKxJhL4wVHH3a5rvQ4avf0
94PGPk0YL8D1sNBkuqqoJMznZO/qwd4c0PJVSX7D/88DkKZ/bJNQBbUOkYZLFpLH2g0d
4LNcStplCVK+rbrqRVC7ISfOieNxgEUsTqxcxTNji3gwkwGlC1UeZtbbwuG3rbMwBLQk
GBsJI3KhIAlHJ8qQ5BZml2LQOP+dv583PdFFeYYz1i7OuFXL9yBohyfXhlMia5tIP/bv
DjrQ==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com;
s=arc-20160816;
h=content-transfer-encoding:mime-version:list-unsubscribe
:list-subscribe:list-id:precedence:message-id:date:subject:cc:to
:from:dkim-signature;
bh=0xtboovQenJVBQAAi6NSZch7I8BK3A6l8xWg5nMv6O0=;
fh=IwsDDw4cI++qKV55VWdUeZ4ZhCgc3XoeixFhWqkK50c=;
b=iguxKci5GS6K+zn8V0JAUMi64mm4fUbRGVckR3aw8XXKH3UpDh0kZ72vUl/5SLISGY
bNrCmASQpjidkSwAU0gpzhF68JfB2Hnavx4VXRG/nWRE216PW8576GvmjJxhlj6+Yrh7
hqbfun6laVBV6lgXpNIvMCY5zeOrMFF3rcS8CZ1K3GfbOKJdMdOq3UlUagN3c8K08mcD
lyZO55P5hmWU3Q1CYYgnSi66QAa2MEKmezfgGh85O8g+rcgjd1VDFFf/zkII/oTSGO9n
e4TvaKvt2WXf4PmFeK6sd/RYO+XHMLdVN8jL0Ms91DGwdOZCk7B/9WCXJBgpEvXY/K52
WVqA==
ARC-Authentication-Results: i=1; mx.google.com;
dkim=pass header.i=@chromium.org header.s=google header.b=ilGGptw2;
spf=pass (google.com: domain of
linux-kernel+bounces-279-ouuuleilei=gmail.com@vger.kernel.org designates
147.75.48.161 as permitted sender)
smtp.mailfrom="linux-kernel+bounces-279-ouuuleilei=gmail.com@vger.kernel.org";
dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org
Received: from sy.mirrors.kernel.org (sy.mirrors.kernel.org. [147.75.48.161])
by mx.google.com with ESMTPS id
11-20020a63174b000000b005c66c225696si12043197pgx.63.2023.12.14.16.15.38
for <ouuuleilei@gmail.com>
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Thu, 14 Dec 2023 16:15:38 -0800 (PST)
Received-SPF: pass (google.com: domain of
linux-kernel+bounces-279-ouuuleilei=gmail.com@vger.kernel.org designates
147.75.48.161 as permitted sender) client-ip=147.75.48.161;
Authentication-Results: mx.google.com;
dkim=pass header.i=@chromium.org header.s=google header.b=ilGGptw2;
spf=pass (google.com: domain of
linux-kernel+bounces-279-ouuuleilei=gmail.com@vger.kernel.org designates
147.75.48.161 as permitted sender)
smtp.mailfrom="linux-kernel+bounces-279-ouuuleilei=gmail.com@vger.kernel.org";
dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org
Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org
[52.25.139.140])
(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
(No client certificate requested)
by sy.mirrors.kernel.org (Postfix) with ESMTPS id D09CBB21EA0
for <ouuuleilei@gmail.com>; Fri, 15 Dec 2023 00:15:34 +0000 (UTC)
Received: from localhost.localdomain (localhost.localdomain [127.0.0.1])
by smtp.subspace.kernel.org (Postfix) with ESMTP id 45639DDBC;
Fri, 15 Dec 2023 00:15:21 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org;
dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org
header.b="ilGGptw2"
X-Original-To: linux-kernel@vger.kernel.org
Received: from mail-ot1-f47.google.com (mail-ot1-f47.google.com
[209.85.210.47])
(using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits))
(No client certificate requested)
by smtp.subspace.kernel.org (Postfix) with ESMTPS id 6CC908F6B
for <linux-kernel@vger.kernel.org>; Fri, 15 Dec 2023 00:15:16 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org;
dmarc=pass (p=none dis=none) header.from=chromium.org
Authentication-Results: smtp.subspace.kernel.org;
spf=pass smtp.mailfrom=chromium.org
Received: by mail-ot1-f47.google.com with SMTP id
46e09a7af769-6d9dbe224bbso152923a34.2
for <linux-kernel@vger.kernel.org>;
Thu, 14 Dec 2023 16:15:16 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=chromium.org; s=google; t=1702599315; x=1703204115;
darn=vger.kernel.org;
h=content-transfer-encoding:mime-version:message-id:date:subject:cc
:to:from:from:to:cc:subject:date:message-id:reply-to;
bh=0xtboovQenJVBQAAi6NSZch7I8BK3A6l8xWg5nMv6O0=;
b=ilGGptw28nTlLCdJb02qLYPENdi4co1aaDGzUnwoIkSw7DFjDReyvC52f9HbMEXB2I
uJpAOYxYqDJCx4YgdiS7G5a8ay0dPEWmZ9VdE1ZWLyj4fw2GOqnRZeeqGGj+XBFxz+Ut
hlZgV9I8h2n0+MvXdwfMkwk3OtO7bai0NLLjY=
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1702599315; x=1703204115;
h=content-transfer-encoding:mime-version:message-id:date:subject:cc
:to:from:x-gm-message-state:from:to:cc:subject:date:message-id
:reply-to;
bh=0xtboovQenJVBQAAi6NSZch7I8BK3A6l8xWg5nMv6O0=;
b=fGO9n3o5zqBNIEBE5HbZjOXmc/VCDkGMTvkIE6cHx/7lPEc+YCilv2nDDVPmOI1P/S
r3KDrIujYp4zDkUoaNgODrjzMnNmTsoPGoAJ1h5t/LH+7xy52VZ4ftdRGkNZxnxlTTEg
DlmhpndhunTZuckaX1w+QdeazfFc8fhprkfJ58GuxOaEf27CdmDHeATpIzG0AY3eV7mx
rDjQdAH8h3funuyGKa1VOLBn8PqqzrOp51ncLNn0wmS3wfwBCL1L/wNq+gbJ6F8ErbAX
L8Cp++cmsUgv2E05B29+vVhoN+JcCPLeyEtwHBF72v//aJo++YHLLmLhgbavwTUksB0N
Guxg==
X-Gm-Message-State: AOJu0YzPIpM9lOa7v42LIOE2TboQVu/DpFn7B2pdaa7WOUB17NDD72eU
33NNBYBSfpvaixOYk7Drv+hlZYUbWPE3hnW9/xw=
X-Received: by 2002:a9d:6349:0:b0:6d9:e4a0:14ec with SMTP id
y9-20020a9d6349000000b006d9e4a014ecmr11949608otk.65.1702599315542;
Thu, 14 Dec 2023 16:15:15 -0800 (PST)
Received: from www.outflux.net (198-0-35-241-static.hfc.comcastbusiness.net.
[198.0.35.241])
by smtp.gmail.com with ESMTPSA id
t2-20020a62d142000000b00690c0cf97c9sm12842748pfl.73.2023.12.14.16.15.14
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Thu, 14 Dec 2023 16:15:14 -0800 (PST)
From: Kees Cook <keescook@chromium.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Kees Cook <keescook@chromium.org>,
linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org,
linux-hardening@vger.kernel.org
Subject: [PATCH] scripts: kernel-doc: Clarify missing struct member
description
Date: Thu, 14 Dec 2023 16:15:13 -0800
Message-Id: <20231215001513.work.563-kees@kernel.org>
X-Mailer: git-send-email 2.34.1
Precedence: bulk
X-Mailing-List: linux-kernel@vger.kernel.org
List-Id: <linux-kernel.vger.kernel.org>
List-Subscribe: <mailto:linux-kernel+subscribe@vger.kernel.org>
List-Unsubscribe: <mailto:linux-kernel+unsubscribe@vger.kernel.org>
MIME-Version: 1.0
X-Developer-Signature: v=1; a=openpgp-sha256; l=867; i=keescook@chromium.org;
h=from:subject:message-id; bh=QKsOWYRCp/n5rNNSl+fiVmAOeST3NAbxG2n0HGWAklE=;
b=owEBbQKS/ZANAwAKAYly9N/cbcAmAcsmYgBle5qR0hEhggWRRLM9EA2TnJywp5QnRoC6Br5Vt
dEH9vAwIX2JAjMEAAEKAB0WIQSlw/aPIp3WD3I+bhOJcvTf3G3AJgUCZXuakQAKCRCJcvTf3G3A
JoQKD/97JH2i8guQRkJZsjAM6k9wulylKqMXSLSjqstDzQ+rYqnNKJ6K3x4j0j+KVihWJtdGfns
UQJ1yaOenbWY+4ac1jIhn2xx7lQblTD9nM4RGIt4Go38dNRDg/P75Lr0RPdExpBmgKfIEg8aoVe
y9FuD/siHpix5UqC4wRZCExW9GUa1sEd+gkJia69jkANT6/wwp/P7DKM0sfN+xbEGV6QUo9ed67
Pe0ama6Qo0oNGW+gbrevk1XVxZePTLZE1NkalGU83mKKyWz9o2llgc5nQeAh/1+3/pGNlCVjBjT
10ONjI3dDiOHufp4dgq1Jet3KrH7I3XPcQMyBBhTQ+J6wNqMrgAW892C8w9H7/lo9U1nmqBua84
yqpIFQNHsX5WfvAZooRpiYbKrc6z9A75Rl5U7K1JQkSNYMKnvo3lQHx64CUBsasmSQD0pJ/BxZv
JzAVPfcNIqy3l0wnuiz6HgVhY0dD3YlECFsR1cpRpn7pM2tesh6Ls2ITYiSehkRbcfeAaaIOlJq
V9RhJMvHF2NI7WymKbUZpZih7yISGvX5Y4oJZ4b9mrobrwGn+b6Kzck60Lzn2Pr2pkJee45Iia+
dS37kZgXxEwtUqOCk/qflREg5cEn2Ln4KohIzkki6OdYTRWRgTFBTfiIgy01RY752wziE2rXbrt
gKlcOizY adm0Fyw==
X-Developer-Key: i=keescook@chromium.org; a=openpgp;
fpr=A5C3F68F229DD60F723E6E138972F4DFDC6DC026
Content-Transfer-Encoding: 8bit
X-getmail-retrieved-from-mailbox: INBOX
X-GMAIL-THRID: 1785304804412204749
X-GMAIL-MSGID: 1785304804412204749
|
| Series |
scripts: kernel-doc: Clarify missing struct member description
|
|
Commit Message
Kees Cook
Dec. 15, 2023, 12:15 a.m. UTC
The output "or member" should be more specific, instead saying "struct
member".
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Kees Cook <keescook@chromium.org>
---
scripts/kernel-doc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Comments
Kees Cook <keescook@chromium.org> writes: > The output "or member" should be more specific, instead saying "struct > member". > > Cc: Jonathan Corbet <corbet@lwn.net> > Cc: linux-doc@vger.kernel.org > Signed-off-by: Kees Cook <keescook@chromium.org> > --- > scripts/kernel-doc | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/scripts/kernel-doc b/scripts/kernel-doc > index 39e730ee1fef..41f838042364 100755 > --- a/scripts/kernel-doc > +++ b/scripts/kernel-doc > @@ -1613,7 +1613,7 @@ sub push_parameter($$$$$) { > $parameterdescs{$param} = $undescribed; > > if (show_warnings($type, $declaration_name) && $param !~ /\./) { > - emit_warning("${file}:$.", "Function parameter or member '$param' not described in '$declaration_name'\n"); > + emit_warning("${file}:$.", "Function parameter or struct member '$param' not described in '$declaration_name'\n"); > } Applied, thanks. jon
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 39e730ee1fef..41f838042364 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -1613,7 +1613,7 @@ sub push_parameter($$$$$) { $parameterdescs{$param} = $undescribed; if (show_warnings($type, $declaration_name) && $param !~ /\./) { - emit_warning("${file}:$.", "Function parameter or member '$param' not described in '$declaration_name'\n"); + emit_warning("${file}:$.", "Function parameter or struct member '$param' not described in '$declaration_name'\n"); } }