Message ID | 20231215001347.work.151-kees@kernel.org |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel+bounces-277-ouuuleilei=gmail.com@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:3b04:b0:fb:cd0c:d3e with SMTP id c4csp8939883dys; Thu, 14 Dec 2023 16:14:14 -0800 (PST) X-Google-Smtp-Source: AGHT+IHxm/zw9xUzxmqqvwFi+OFV+YuvS0HvUdMw7oCMX0+8wV3UOqQERZb9UcMf4WAnJtG9TGRI X-Received: by 2002:a05:6214:d8e:b0:67f:9b4:a93b with SMTP id e14-20020a0562140d8e00b0067f09b4a93bmr1853967qve.59.1702599254557; Thu, 14 Dec 2023 16:14:14 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1702599254; cv=none; d=google.com; s=arc-20160816; b=iy0cgHvV45+s2Au5Uea0LOcgTS6+jjz5FbIYhBcNr2E5uuWLOX1rBiTwK9IeNsIKYB z7dCIwGX66UN5yphU0qj9Ka+XsodcMKnLTnYgHWrScKpvC3uxzlVhO5tFiWiyW4tM272 ah14p7TOYzxYq1PU4dbi8mxzOxY+bsBxeSzcqUoLHJINgexETsQSaPksABoC3kFbTA8F Q32YwS6HtL26QVXihuM94LV1adpYf7SJOyldX49GkNKFQ2FMwVY1GgiEqbsE5g2ZmGJ2 ElWRSu3H9sjeMSAHNkYh9nj7nLdsNFM46THhsD51+3lb7WcnBLjG+XqwOcnQ9/ejNGLu E71A== 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=cHIT4/zAOsjoCOmWaVZrUI8chkh81MpK3rRyl2+SwGk=; fh=FmCEC+mGPokyhOAhbwwWogVNz6qZA5v3DTJ327E+3mo=; b=Ipf8gytwVQdIN3B/c5A/uP9+rFW2k3FC1TEKGQ0WaDTmFvaXstuTRDhqKR5/mnRqwh LN7HUULRytAzf/u7DyprJ4xuedQ5DrPW6fDOxCwITfjNmpXwIozizYS2kozc5hfOgavw f5+4cTB5ulhOnFcPU4vyJY7FJRq1UScA5BMZDVOGkPy79+sgT75qpMCSaoJ4TntDKkMx 3ntkr/IWaGTEWJosWiPukr+2V5wp8bg8+m3ReSNvqH+TA9qTb0iBlbpBi2JK+KEcArbW nIyRiqNoEfwe/KQPb7IBtTbz8cppvr3XrmY3bYRriyStqGk7jCUDMLvzpNovlL/RpL79 9cCQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=OxqsLOZa; spf=pass (google.com: domain of linux-kernel+bounces-277-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-277-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [147.75.199.223]) by mx.google.com with ESMTPS id g16-20020a0ce4d0000000b0067f0ff18e76si1713818qvm.546.2023.12.14.16.14.14 for <ouuuleilei@gmail.com> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Dec 2023 16:14:14 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-277-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223; Authentication-Results: mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=OxqsLOZa; spf=pass (google.com: domain of linux-kernel+bounces-277-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-277-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 ny.mirrors.kernel.org (Postfix) with ESMTPS id 5ABB21C21FAC for <ouuuleilei@gmail.com>; Fri, 15 Dec 2023 00:14:14 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 0B7F61C11; Fri, 15 Dec 2023 00:14:01 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="OxqsLOZa" X-Original-To: linux-kernel@vger.kernel.org Received: from mail-pl1-f179.google.com (mail-pl1-f179.google.com [209.85.214.179]) (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 E7CB110F3 for <linux-kernel@vger.kernel.org>; Fri, 15 Dec 2023 00:13:56 +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-pl1-f179.google.com with SMTP id d9443c01a7336-1d2f1cecf89so171135ad.1 for <linux-kernel@vger.kernel.org>; Thu, 14 Dec 2023 16:13:56 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1702599236; x=1703204036; 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=cHIT4/zAOsjoCOmWaVZrUI8chkh81MpK3rRyl2+SwGk=; b=OxqsLOZaRjzy0Xhbsa24tmzk1Ln3aImW0Ng/IaxjTr1V3OV91TaCNyaRFX9N1lBo6t VYQT4/DQZDdQCFmC6e3dQI3FEOBXuCU3HK9CWI/UWMKIJus6N8Qk1frP7DaslyOiVipu uwtUX1qFjhLzg1GRbtJ4zxMyCGIo5ujUJaXxY= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1702599236; x=1703204036; 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=cHIT4/zAOsjoCOmWaVZrUI8chkh81MpK3rRyl2+SwGk=; b=ZtaE4odiFVMkgZ2ceFRQt2hm4g13M6tE7jLOFf5HWHavnSs30WYRV0G4n0ySyLISGz 0yaVrMJAMUvE+K+PFxNRLOJVPkoKVrbjGEqi6lE8aofNdG9YP1gz71w00CB6D1phvE3E nCkzH8IvFKS6NJnAlT/tmzjCuqA9t4NqY8hVGkTAl+8khwY8WgrLHqbmfzN2j1ub9oJ6 JdEDn0FA8tFQVKPVbpBtcOUpnMMCFgRpNRynJdWvDURgy6uApucw9YtpZA6ew1j+UzLr zUT+XBgKfqga8PROuRYFtuEb6ksiR5fBpkj4Eu9uOGo9sL9Zid7CSytjoPJJ5y5IC0Ig 7s3g== X-Gm-Message-State: AOJu0Ywj9syondT8OWFRq/DYxO4D0a48uNHmNnKgK9VDvTiMVExvTgFx KV0Ldn5dZwST1qUNM1FYabjecw== X-Received: by 2002:a17:903:1206:b0:1cc:70dd:62c3 with SMTP id l6-20020a170903120600b001cc70dd62c3mr6192101plh.30.1702599236263; Thu, 14 Dec 2023 16:13:56 -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 13-20020a170902e9cd00b001d33369bd86sm6043400plk.194.2023.12.14.16.13.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Dec 2023 16:13:55 -0800 (PST) From: Kees Cook <keescook@chromium.org> To: Jonathan Corbet <corbet@lwn.net> Cc: Kees Cook <keescook@chromium.org>, kernel test robot <lkp@intel.com>, "Gustavo A. R. Silva" <gustavoars@kernel.org>, linux-doc@vger.kernel.org, linux-hardening@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH] docs: conf.py: Ignore __counted_by attribute Date: Thu, 14 Dec 2023 16:13:54 -0800 Message-Id: <20231215001347.work.151-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=932; i=keescook@chromium.org; h=from:subject:message-id; bh=B2tqTdN1yLmid/EvyON0m6Bfx8ewzrdTGIvQQwD+wX0=; b=owEBbQKS/ZANAwAKAYly9N/cbcAmAcsmYgBle5pB94LTh/NaR3Tal7Cmsx2UUklX8ibKe88nW Ri1Cv3sHM2JAjMEAAEKAB0WIQSlw/aPIp3WD3I+bhOJcvTf3G3AJgUCZXuaQQAKCRCJcvTf3G3A JmLJD/wMo4+veMXHS0H1dNZxX0gG8ziwAaIX0G6s5TbvI34upjeUlVz7mg7moCz5hBpc2Vvds3R NjflzseoIBGU+WKdpikTaDKH7Nx/sv5mRQumrFCQHkBe8axEBRer/616+QRNUo3HLsV1SkOALjv i4s2F2J+FHW/JoY5YjhRAAKuSog/xKoVEXoh8AvvBgzExTt0l02MDrAEUeZps1HffepMjtPvMXW xYvpN7XHS5tOT9jz46YPqQbmAHT7ji8LEvA7VbYLWZHn4gYBj/Vla18GaVe8dQRVmitQ7nnWuxf A/vupnFw0Ah0m4FX5E1hBbtJi43lrWIEc4u6aOKUnnim6HgAZtzYQ8aEFAwbXm9jhInkFvNx4yP mYvcqWlIvuKC5aVC2yiOCRvBVMoRStj4KK3+BH+hAA+tk8i4n6ApgQzHTu4gJHBpRhiwMwytRH3 TNjvydi9A+MMkSLz1+2ISiYZy+lfw/yfs75+992QKXZT27DaI3ZXiBNhQk51QXoLQ7TONfYGS3y oc+GFG5qHO7es33mud4hZ2PuHMLmbItow+duptqdBBcst/THrfhNPj22T20O3JQRXn8RnSPNhKY 4K0e7FsC52XIuRl3NAdeuIOaRY6QNIP7xvt22K2d7RloHaCg5AxWViFiKb0t+lS+24LXg7p/2J1 LzSBUzZe 9aquL5A== X-Developer-Key: i=keescook@chromium.org; a=openpgp; fpr=A5C3F68F229DD60F723E6E138972F4DFDC6DC026 Content-Transfer-Encoding: 8bit X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785304715969713501 X-GMAIL-MSGID: 1785304715969713501 |
Series |
docs: conf.py: Ignore __counted_by attribute
|
|
Commit Message
Kees Cook
Dec. 15, 2023, 12:13 a.m. UTC
It seems that Sphinx is confused by the __counted_by attribute on struct
members. Add it to the list of known attributes.
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202312150614.kOx8xUkr-lkp@intel.com/
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: "Gustavo A. R. Silva" <gustavoars@kernel.org>
Cc: linux-doc@vger.kernel.org
Cc: linux-hardening@vger.kernel.org
Signed-off-by: Kees Cook <keescook@chromium.org>
---
Documentation/conf.py | 1 +
1 file changed, 1 insertion(+)
Comments
On 12/14/23 16:13, Kees Cook wrote: > It seems that Sphinx is confused by the __counted_by attribute on struct > members. Add it to the list of known attributes. > > Reported-by: kernel test robot <lkp@intel.com> > Closes: https://lore.kernel.org/oe-kbuild-all/202312150614.kOx8xUkr-lkp@intel.com/ > Cc: Jonathan Corbet <corbet@lwn.net> > Cc: "Gustavo A. R. Silva" <gustavoars@kernel.org> > Cc: linux-doc@vger.kernel.org > Cc: linux-hardening@vger.kernel.org > Signed-off-by: Kees Cook <keescook@chromium.org> > --- > Documentation/conf.py | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/Documentation/conf.py b/Documentation/conf.py > index d4fdf6a3875a..5898c74b96fb 100644 > --- a/Documentation/conf.py > +++ b/Documentation/conf.py > @@ -106,6 +106,7 @@ if major >= 3: > "__weak", > "noinline", > "__fix_address", > + "__counted_by", > > # include/linux/memblock.h: > "__init_memblock", If Sphinx needs to know about that, then fine. OTOH, for scripts/kernel-doc, a similar change could have been made to dump_struct(), along with these others: # strip attributes $members =~ s/\s*$attribute/ /gi; $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos; $members =~ s/\s*__packed\s*/ /gos; $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos; $members =~ s/\s*____cacheline_aligned_in_smp/ /gos; $members =~ s/\s*____cacheline_aligned/ /gos;
On Thu, Dec 14, 2023 at 04:25:01PM -0800, Randy Dunlap wrote: > > > On 12/14/23 16:13, Kees Cook wrote: > > It seems that Sphinx is confused by the __counted_by attribute on struct > > members. Add it to the list of known attributes. > > > > Reported-by: kernel test robot <lkp@intel.com> > > Closes: https://lore.kernel.org/oe-kbuild-all/202312150614.kOx8xUkr-lkp@intel.com/ > > Cc: Jonathan Corbet <corbet@lwn.net> > > Cc: "Gustavo A. R. Silva" <gustavoars@kernel.org> > > Cc: linux-doc@vger.kernel.org > > Cc: linux-hardening@vger.kernel.org > > Signed-off-by: Kees Cook <keescook@chromium.org> > > --- > > Documentation/conf.py | 1 + > > 1 file changed, 1 insertion(+) > > > > diff --git a/Documentation/conf.py b/Documentation/conf.py > > index d4fdf6a3875a..5898c74b96fb 100644 > > --- a/Documentation/conf.py > > +++ b/Documentation/conf.py > > @@ -106,6 +106,7 @@ if major >= 3: > > "__weak", > > "noinline", > > "__fix_address", > > + "__counted_by", > > > > # include/linux/memblock.h: > > "__init_memblock", > > If Sphinx needs to know about that, then fine. OTOH, for scripts/kernel-doc, I *think* it does -- I can't reproduce the robot warnings myself. > a similar change could have been made to dump_struct(), along with these > others: > > # strip attributes > $members =~ s/\s*$attribute/ /gi; > $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos; > $members =~ s/\s*__packed\s*/ /gos; > $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos; > $members =~ s/\s*____cacheline_aligned_in_smp/ /gos; > $members =~ s/\s*____cacheline_aligned/ /gos; scripts/kernel-doc doesn't actually need this -- it already processes struct members in a way that seems to ignore trailing attributes. -Kees
Kees Cook <keescook@chromium.org> writes: > It seems that Sphinx is confused by the __counted_by attribute on struct > members. Add it to the list of known attributes. > > Reported-by: kernel test robot <lkp@intel.com> > Closes: https://lore.kernel.org/oe-kbuild-all/202312150614.kOx8xUkr-lkp@intel.com/ > Cc: Jonathan Corbet <corbet@lwn.net> > Cc: "Gustavo A. R. Silva" <gustavoars@kernel.org> > Cc: linux-doc@vger.kernel.org > Cc: linux-hardening@vger.kernel.org > Signed-off-by: Kees Cook <keescook@chromium.org> > --- > Documentation/conf.py | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/Documentation/conf.py b/Documentation/conf.py > index d4fdf6a3875a..5898c74b96fb 100644 > --- a/Documentation/conf.py > +++ b/Documentation/conf.py > @@ -106,6 +106,7 @@ if major >= 3: > "__weak", > "noinline", > "__fix_address", > + "__counted_by", Applied, thanks. jon
diff --git a/Documentation/conf.py b/Documentation/conf.py index d4fdf6a3875a..5898c74b96fb 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -106,6 +106,7 @@ if major >= 3: "__weak", "noinline", "__fix_address", + "__counted_by", # include/linux/memblock.h: "__init_memblock",