From nobody Sat Nov 15 05:39:10 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1755191719; cv=none; d=zohomail.com; s=zohoarc; b=FyPnCScsYa2P0q6/LbnXd4JkW7+oX0Q3sucZ76qiVqVlM95AsfUAgqSZcddQJ+iiz2gW5BVpsFNBpJ2HDRO3EFWqySSTqxdfkpY4qa2+ps844P3XyaHAEk/sqR20HGzAZ9UrNYSxAwQgOtLCuub6JNrlWBSwOorpt1OHTDAZ8Ew= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1755191719; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=mTW8JUKYJrzyjOYJQzVwpdJf42zS48hJmAThckQDc8A=; b=LK9lJVpXG8UNYZW5942Yc3/J4OL7m4zkzePf0YADXI2/27t9MpxdC+GxE5PrUJIYIqle0BVi/96aFa95I6escBOyhooC4krcq/C4N5mdoB+OhMzk3As98bMh/fNAiAy9P+G74PuLEIb8qOF0RLlZlc0iJ/8V5ywcmOED7FgJjAw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1755191719298765.2818526634817; Thu, 14 Aug 2025 10:15:19 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1umbWA-0008KX-RU; Thu, 14 Aug 2025 13:13:34 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1umbW9-0008Jp-1u for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:33 -0400 Received: from mail-wm1-x330.google.com ([2a00:1450:4864:20::330]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1umbW6-0001ny-Oo for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:32 -0400 Received: by mail-wm1-x330.google.com with SMTP id 5b1f17b1804b1-45a1b065d59so6342465e9.1 for ; Thu, 14 Aug 2025 10:13:28 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [2001:8b0:1d0::2]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-45a1c76e9basm29489165e9.21.2025.08.14.10.13.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Aug 2025 10:13:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1755191607; x=1755796407; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=mTW8JUKYJrzyjOYJQzVwpdJf42zS48hJmAThckQDc8A=; b=O6X4IK5XeyPBUIXSF9Ov6gcgNFMr4/JcP3lK6PuftB6ibp6NF5K7bx8OWozioL9nFK ApgPryMmId0Kjfm9ME62NEgBzZIXGUUkdjl76WvteXrg+uWZD9Xy0xssQhq81p7Skp16 Wdmy5A8HttAzsch4e053Cf4w4dbtrEivD16SeckoNI6Wjn7se6O0Bs9zswHww2j5tOLD T1AIfjsSqKg6DEq8ZLak4bdWyHVTt9ne5TELTzmmG1a6t0sylLGTmI1tgcgaprcNYs5M 73+3/qwPY9SoshgBojajRIBLBhwBNZKUhorC7/8IR4r4OLOIftHoy1i5HHavcGaQ39WP V68A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1755191607; x=1755796407; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=mTW8JUKYJrzyjOYJQzVwpdJf42zS48hJmAThckQDc8A=; b=RBra4F1aVC0i4FzGB7/2cBbg7FFwFRUdZhZY9Lh69N+lirMtbd/yokzKaCDpTzI5xM 7L79QE0lYMcLpSyMXLHiVxr/8jN2QtznvkYnkDolPVOWpgMurJdi27IbLXXv7GfYWFKz KRsOI93F/7ioFI2vVm7NkzSEPzpG5CMATAYdLqzfYMYCaOIjCs0Oq29+w6Q/lLzODE/P wUIIqJHa9HnslGL/tPQ6DdLVAU03R8iEwEOsT0vizy/jHr/nBplyKjzO/vS1hFHVF+Lo 7iNhGI65juexYIWTOaUKI5Ars6qwzpqPNcidXlbUoK5Z5XoR00yietujPFJSOBtKjvvL o0KA== X-Gm-Message-State: AOJu0YyDzU2gSL8W4XfEJH080mtNccD9U0KeXgVRpMfREnaY+6ktIaFN KRVH92M5FO7EOY9gBlDErNf4z85PKnm2TcrH+Q814Q1+H1MyQ71riFjLKpCXhsWDlFwb8HG52um VTJGB X-Gm-Gg: ASbGncteeG1cwoI1kdTRyaZ/YuXF14K96HCrlYVMP66wi66JftmdTzscGNCVv2aSq/L PwGT0GUIYwzJnQYKZpY5bGtUVMhzHDDAzmLrvInioeddYu+3txqBSUi7RgZUXWnyHuUjgR2bUFO fI/iYN1s+hnNZGgIyC3N+N9ynud47UTTMJ0Tm1FCGHUVkBIMcOQ/oC/FBWPxn4lW/WKG5Ud82Mt 2cwa4Q8JMXTqw1UiUzdp61UscZ1HTAg0Ut54G+IwPY+QuD7AAddbR+Cxx7dyVH7nzyVZ0Eg4TgF gta9WFLPJdw9DUX6O1PfuatrcP5CKKbPxmx937Zgv9jQVdSLk3TRDlUKbrfg5qyy0Rxkr9wrvki Pld0xIsBKUto8SJho58ehClDJjknw X-Google-Smtp-Source: AGHT+IGSYI/ZYJNVuLFZVuG7TzXgclSacAgto5mgDCp5Qd/MD/u//hHKjkBeRBwcocHrRDQkDS3N2A== X-Received: by 2002:a05:600c:1c1b:b0:453:5c30:a1fd with SMTP id 5b1f17b1804b1-45a1b61e3a5mr28262765e9.8.1755191607227; Thu, 14 Aug 2025 10:13:27 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Cc: Paolo Bonzini , John Snow Subject: [PATCH for-10.2 1/8] docs/sphinx/kerneldoc.py: Handle new LINENO syntax Date: Thu, 14 Aug 2025 18:13:16 +0100 Message-ID: <20250814171324.1614516-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250814171324.1614516-1-peter.maydell@linaro.org> References: <20250814171324.1614516-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::330; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x330.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1755191721963124100 Content-Type: text/plain; charset="utf-8" The new upstream kernel-doc that we plan to update to uses a different syntax for the LINENO directives that the Sphinx extension parses: instead of #define LINENO 86 it has .. LINENO 86 Update the kerneldoc.py extension to handle both syntaxes, so that it will work with both the old and the new kernel-doc. Signed-off-by: Peter Maydell Reviewed-by: Mauro Carvalho Chehab Reviewed-by: Paolo Bonzini --- docs/sphinx/kerneldoc.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/kerneldoc.py b/docs/sphinx/kerneldoc.py index 3aa972f2e89..30bb3431983 100644 --- a/docs/sphinx/kerneldoc.py +++ b/docs/sphinx/kerneldoc.py @@ -127,7 +127,7 @@ def run(self): result =3D ViewList() =20 lineoffset =3D 0; - line_regex =3D re.compile("^#define LINENO ([0-9]+)$") + line_regex =3D re.compile(r"^(?:\.\.|#define) LINENO ([0-9]+)$= ") for line in lines: match =3D line_regex.search(line) if match: --=20 2.43.0 From nobody Sat Nov 15 05:39:10 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1755191701; cv=none; d=zohomail.com; s=zohoarc; b=WvLDapNeXmgvwLrzFo290MPMTD7rAdbzVsiuM6zclfSWUCrJFSLavva+dWxnTclt6oDg+fL5w3X0VuOpig03lUWlnmMNH3MAlRAGTLSb/S8WPpMqLBRUPpbX7LiKuJKzk/ehEN8DAkqcHMqZ3JVLIpm/ezEfLYriv6cq+nrGHWg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1755191701; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=U/46L7LCx+ViKp1ECz1DIdRKRlnUT0rkmHhzvlzb9iM=; b=U88YxqRnyBZz+rBv7U4DE7RJUYPimecpaaWihYWSdeBpRM5Y5PYoLqMyLNYxFweFu8iD/FP3/fErloNuJLlVPzKYvCRejMA+RNftnowaWKEeruThRPRDvfYHiZFLNaxpy5TGtdk/1w3bNXdjK+LTolrsHdvkigbWacK03CVs1H4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1755191701342848.2234779729165; Thu, 14 Aug 2025 10:15:01 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1umbWD-0008LW-HF; Thu, 14 Aug 2025 13:13:37 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1umbWA-0008KW-7o for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:35 -0400 Received: from mail-wm1-x32f.google.com ([2a00:1450:4864:20::32f]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1umbW6-0001oD-Vb for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:33 -0400 Received: by mail-wm1-x32f.google.com with SMTP id 5b1f17b1804b1-45a1b281d25so5039645e9.3 for ; Thu, 14 Aug 2025 10:13:30 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [2001:8b0:1d0::2]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-45a1c76e9basm29489165e9.21.2025.08.14.10.13.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Aug 2025 10:13:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1755191608; x=1755796408; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=U/46L7LCx+ViKp1ECz1DIdRKRlnUT0rkmHhzvlzb9iM=; b=CIeBsSB37Q+cQ6Kw78p98jwy1EBB2xamF8q0QQ5aYgQdDZnmtdXFV/LDqnBg1QVjQH ipiFdhOSm04RxPE+GwqwHoaTwtbnjwir2WUImwhFEm6fLdGHCh/ZyDAMbt73nVW3u0x6 93ZhFEyKS5j6O62VsNK3KSYjA7RbDrPcaX1aKaldZTqg0jWXiIPrdxDCqxKzYLOkbZFD qYE/fU8akBg9WVqkOyAtdfVldgkllyx8PICdx0DBnJ/vehttzlyBXBCGWcWOFBN5n19A fybSo3b/hed23pI6wavSLn7oyt2TUFmjoxHCNOBmzvdEqRCsZ5k/+6pssH2q2D6oQ2PD fkXw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1755191608; x=1755796408; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=U/46L7LCx+ViKp1ECz1DIdRKRlnUT0rkmHhzvlzb9iM=; b=e1n81wzh5Bgew2PQfD67NJmjG8/gf1hKE8QEVk85uDSjBurdJfMgX9QV3hxoN89y3I 1SEwKe94QCR6ocyozbOYqe0VA/JnwbmRlErd60LW5w3YmoF0LWEy3C8BpL0YjpUyqKXY eQdqKqqjLeXwEN1HuBYjqH0bNcB75ANtVMLxEKaeWB6EcGcw2L9lQ9CV0TSTGtrZqqgO Rj3Q/tncpN+wYAOdVgNJkut4sJGTNou5VvZqGTBNUYhHwkACXAbwlfFA4cmyuAmbDSnJ phKpHcUGrri9dm9hgIs+7BKCBEZKZHYMmPQJWMYIb8k2LKNjd4duSAWt8l5a0uzY4GYG HVFw== X-Gm-Message-State: AOJu0Yw99INT3J4WYsdfZYR5mKzmPswRJtrVb4KDRcTlylVXpysoMSlX UiN1i4vYVYEVjmSccUeSrNmiqAOonHpvdL5kOqI3CBFdRBIdvvX9IfCVTL2XhPOnrT9WLiSNOmD XhJUv X-Gm-Gg: ASbGnctV0/l2ui9deeHGHMgfP7eQVp7w0w3I97pGVyi7rRcHnPrLYYUUoC1NCVAfaUM zDE4N9+8Pz1ezYuOvwslQA8fbnqyJJDmmslAsBHwzAC89sAoeywVc/AGVVputOBDsNR5L0j3SFZ 65IXX2GqWsCkWfy9N4cYDhPJSgRD34R0n8lr1D592/HF2i8cOjn+5rqGerTLiWkwI2m3p4bOPl/ iH4LGL2JvhMJa3ZR2lLVNP1bdolOnPkEXb/CDJKYqCvQyF7ix9q0vSJb8tuBo5FmF/Ay3lxMTgt URVYd/AfV/QjIbKEQ3QVFNA9RZfL7z5d2Xf73zu8nQLXfiFA2KiIQM3kiWihdk1WSHuF32Aa9+p y43YYOzSNdGYuXFdTEvCJwn4kWRt+ X-Google-Smtp-Source: AGHT+IGPdgHC5HzAB1OyQkJ+vyuTysxIbwFjPG7Xz1GvCW28Eh3WKaGjaCWGvXZR0l+X3XLZndtvpg== X-Received: by 2002:a05:600c:5486:b0:456:201a:99f with SMTP id 5b1f17b1804b1-45a1b644a54mr37927505e9.18.1755191608203; Thu, 14 Aug 2025 10:13:28 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Cc: Paolo Bonzini , John Snow Subject: [PATCH for-10.2 2/8] tests/qtest/libqtest.h: Remove stray space from doc comment Date: Thu, 14 Aug 2025 18:13:17 +0100 Message-ID: <20250814171324.1614516-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250814171324.1614516-1-peter.maydell@linaro.org> References: <20250814171324.1614516-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::32f; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x32f.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1755191703990124100 Content-Type: text/plain; charset="utf-8" The doc comment for qtest_cb_for_every_machine has a stray space at the start of its description, which makes kernel-doc think that this line is part of the documentation of the skip_old_versioned argument. The result is that the HTML doesn't have a "Description" section and the text is instead put in the wrong place. Remove the stray space. Signed-off-by: Peter Maydell Reviewed-by: Mauro Carvalho Chehab Reviewed-by: Paolo Bonzini --- tests/qtest/libqtest.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/qtest/libqtest.h b/tests/qtest/libqtest.h index b3f2e7fbefd..fd27521a9c7 100644 --- a/tests/qtest/libqtest.h +++ b/tests/qtest/libqtest.h @@ -977,7 +977,7 @@ void qtest_qmp_fds_assert_success(QTestState *qts, int = *fds, size_t nfds, * @cb: Pointer to the callback function * @skip_old_versioned: true if versioned old machine types should be skip= ped * - * Call a callback function for every name of all available machines. + * Call a callback function for every name of all available machines. */ void qtest_cb_for_every_machine(void (*cb)(const char *machine), bool skip_old_versioned); --=20 2.43.0 From nobody Sat Nov 15 05:39:10 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1755191703; cv=none; d=zohomail.com; s=zohoarc; b=fgCTbuPvUbSz4putkDgWrGzCZnsQjvxu3N0NtXzFag4GeFbBRScqROnkh9BSFC8uoVy4IbiygdO1c6vfSH2YeF1zZRYO1UCGzKFfNx+s1vtNE9akR6txX7myIowq4zacMaOkMC5aQRkyBhbnYqapnkaVdqQIISpyh6yFnwpwkpA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1755191703; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=3W6DLhnZ6DCDdLnuWJ0zVGG8lRNh4APlwHPPG80n548=; b=b1TOK0ok4FhJ5+bDRENA3F/pADzT7HCuRkXivcWW0Sfbab9l8ExxSZz2MMD4Ta6+rVAC2DDcsi9dKJ1Ub/e3SqpX1O9YACe5BG6NFaULd9s3GoPcFZY9uwcrmUtBz5as7S34hXB6T+Jxs++8ygoDFZirT5YxbwAPqmcPfjXFrso= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 175519170393647.50760251083602; Thu, 14 Aug 2025 10:15:03 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1umbWG-0008NO-V1; Thu, 14 Aug 2025 13:13:40 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1umbWE-0008MU-Tc for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:39 -0400 Received: from mail-wm1-x334.google.com ([2a00:1450:4864:20::334]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1umbW9-0001oY-0G for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:38 -0400 Received: by mail-wm1-x334.google.com with SMTP id 5b1f17b1804b1-45a1b0c52f3so6097745e9.3 for ; Thu, 14 Aug 2025 10:13:32 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [2001:8b0:1d0::2]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-45a1c76e9basm29489165e9.21.2025.08.14.10.13.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Aug 2025 10:13:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1755191610; x=1755796410; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=3W6DLhnZ6DCDdLnuWJ0zVGG8lRNh4APlwHPPG80n548=; b=hSmHbQqeIljwb+GNcoXsrIWdlNHX7Tqvxba/zyizWWte2GCZ8Zv7C5+PSjblP3HzSt PM41QnHJvZ9WuXkvO0Ijrf1PYuAtzJfqfnaNb976vp9D6qmaqXsjh4ZrQXic7Lx7Rz0O XYs3GroE8TiwJMMiMI/O5IcUmyn1WBTi3hyePBAO5JGOheWIPgglvYprvun0q084rAUU G/fuPfGy+on6sL0CvDA/AZ5Lu6cThc0jIinJpRePaFtttc6TPFOYqruDsQ+w5o9ChoAd pDDo+zG9VqDhyQFH0DkpeQs5wAoGn+QvnRFZD0Tkw65nYUuC9wll+jvfOCMIA9EwAMOz KweA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1755191610; x=1755796410; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=3W6DLhnZ6DCDdLnuWJ0zVGG8lRNh4APlwHPPG80n548=; b=WbGTt/P0qFWK/QEOY6+pJ4sejhPa/jYVxoLkza5fMxdvwwlfrAVBZbCY+yv5f4VEE6 ybGeniUCBQFh9pTMqdWNT66Z9ChsSzB2xRBf9le+EvbHZs3bl7SzZ3uZONh5fsT6zoQA XUQgclir6HV2pRZzTgkM4DpbsrWUWvjTD+W4IZlgKP4oAZjuIW64eLDlSIKZtA9ayfxX Ff0JkV0XT6uHvFcpkGb9LOidbPEXsRBnhmOgWx90Lf1YLokbOyW1v/JdeSbt/t9PYcR1 ILp9IA83LWiVoRWLXQnJQusDj0mZyOTALvL25wBheXNK5DBZNRX2fMl1Xp7eaRw4MKJ+ 9wSA== X-Gm-Message-State: AOJu0YwfkKCMsj7s7/HG0oM5I1tor5cMVSEO8adEmR6N2AIzgK+D1500 zaeMetHJ8FO8B8q+LYukBptVtUcjD5dcYPAhFS1hupoK6eyzfvLTtmyNOkXDKY6TcTvtyKHAoqB fHkVf X-Gm-Gg: ASbGncuZk3o2ybok5Tf8UNTqMWcFP1mtyEX+4Y3aVTQyOw6ATMwFx3krIdVIMYTSIwP MMMIMs5CE7lXyQVe2SEMMbRV7sP2U7PVGdDSz7dfP3h8V4Q3kkRik2rqRaMUXEFTFQyeE+Hr91Q aavGVYrJFt4KC2k9x34aQf4xJMDEk0BNKKC2IYx7HBKcq0j5g0l2r5Q5XEqATVxbG9z+oU7HMUE Koc2JiT51IR6eLqBc9lpZnST8krBrYsOWNxGD27Ne8gN3W6p118dPyRWUoY9jC9F5QdgiYjsx7a eVGYIFWGBFhicknl/7pzKx2j+LHzyuVVC80I2Q4kdlYRjec06Nh2oBMGYdHSK+FqYX4/0p9UAy0 FnkEvXWoqcOhFxrNQY1tHKMp8XQpA X-Google-Smtp-Source: AGHT+IHZMpoFQHrWiDQUKxomba8lf62QhhPjOj+Oqx59tE8SLTqCXzAVMYHN6gOmZZDChH/6rfOpsQ== X-Received: by 2002:a05:600c:3b1a:b0:458:c059:7db1 with SMTP id 5b1f17b1804b1-45a1b668ac4mr41678285e9.30.1755191609430; Thu, 14 Aug 2025 10:13:29 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Cc: Paolo Bonzini , John Snow Subject: [PATCH for-10.2 3/8] scripts: Import Python kerneldoc from Linux kernel Date: Thu, 14 Aug 2025 18:13:18 +0100 Message-ID: <20250814171324.1614516-4-peter.maydell@linaro.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250814171324.1614516-1-peter.maydell@linaro.org> References: <20250814171324.1614516-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::334; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x334.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1755191706087124100 We last synced our copy of kerneldoc with Linux back in 2020. In the interim, upstream has entirely rewritten the script in Python, and the new Python version is split into a main script plus some libraries in the kernel's scripts/lib/kdoc. Import all these files. These are the versions as of kernel commit 0cc53520e68be, with no local changes. We use the same lib/kdoc/ directory as the kernel does here, so we can avoid having to edit the top-level script just to adjust a pathname, even though it is probably not the naming we would have picked if this was a purely QEMU script. The Sphinx conf.py still points at the Perl version of the script, so this Python code will not be invoked to build the docs yet. Signed-off-by: Peter Maydell Reviewed-by: Mauro Carvalho Chehab Reviewed-by: Paolo Bonzini --- scripts/kernel-doc.py | 325 ++++++ scripts/lib/kdoc/kdoc_files.py | 291 ++++++ scripts/lib/kdoc/kdoc_item.py | 42 + scripts/lib/kdoc/kdoc_output.py | 749 ++++++++++++++ scripts/lib/kdoc/kdoc_parser.py | 1669 +++++++++++++++++++++++++++++++ scripts/lib/kdoc/kdoc_re.py | 270 +++++ 6 files changed, 3346 insertions(+) create mode 100755 scripts/kernel-doc.py create mode 100644 scripts/lib/kdoc/kdoc_files.py create mode 100644 scripts/lib/kdoc/kdoc_item.py create mode 100644 scripts/lib/kdoc/kdoc_output.py create mode 100644 scripts/lib/kdoc/kdoc_parser.py create mode 100644 scripts/lib/kdoc/kdoc_re.py diff --git a/scripts/kernel-doc.py b/scripts/kernel-doc.py new file mode 100755 index 00000000000..fc3d46ef519 --- /dev/null +++ b/scripts/kernel-doc.py @@ -0,0 +1,325 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0 +# Copyright(c) 2025: Mauro Carvalho Chehab . +# +# pylint: disable=3DC0103,R0915 +# +# Converted from the kernel-doc script originally written in Perl +# under GPLv2, copyrighted since 1998 by the following authors: +# +# Aditya Srivastava +# Akira Yokosawa +# Alexander A. Klimov +# Alexander Lobakin +# Andr=C3=A9 Almeida +# Andy Shevchenko +# Anna-Maria Behnsen +# Armin Kuster +# Bart Van Assche +# Ben Hutchings +# Borislav Petkov +# Chen-Yu Tsai +# Coco Li +# Conch=C3=BAr Navid +# Daniel Santos +# Danilo Cesar Lemes de Paula +# Dan Luedtke +# Donald Hunter +# Gabriel Krisman Bertazi +# Greg Kroah-Hartman +# Harvey Harrison +# Horia Geanta +# Ilya Dryomov +# Jakub Kicinski +# Jani Nikula +# Jason Baron +# Jason Gunthorpe +# J=C3=A9r=C3=A9my Bobbio +# Johannes Berg +# Johannes Weiner +# Jonathan Cameron +# Jonathan Corbet +# Jonathan Neusch=C3=A4fer +# Kamil Rytarowski +# Kees Cook +# Laurent Pinchart +# Levin, Alexander (Sasha Levin) +# Linus Torvalds +# Lucas De Marchi +# Mark Rutland +# Markus Heiser +# Martin Waitz +# Masahiro Yamada +# Matthew Wilcox +# Mauro Carvalho Chehab +# Michal Wajdeczko +# Michael Zucchi +# Mike Rapoport +# Niklas S=C3=B6derlund +# Nishanth Menon +# Paolo Bonzini +# Pavan Kumar Linga +# Pavel Pisa +# Peter Maydell +# Pierre-Louis Bossart +# Randy Dunlap +# Richard Kennedy +# Rich Walker +# Rolf Eike Beer +# Sakari Ailus +# Silvio Fricke +# Simon Huggins +# Tim Waugh +# Tomasz Warnie=C5=82=C5=82o +# Utkarsh Tripathi +# valdis.kletnieks@vt.edu +# Vegard Nossum +# Will Deacon +# Yacine Belkadi +# Yujie Liu + +""" +kernel_doc +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Print formatted kernel documentation to stdout + +Read C language source or header FILEs, extract embedded +documentation comments, and print formatted documentation +to standard output. + +The documentation comments are identified by the "/**" +opening comment mark. + +See Documentation/doc-guide/kernel-doc.rst for the +documentation comment syntax. +""" + +import argparse +import logging +import os +import sys + +# Import Python modules + +LIB_DIR =3D "lib/kdoc" +SRC_DIR =3D os.path.dirname(os.path.realpath(__file__)) + +sys.path.insert(0, os.path.join(SRC_DIR, LIB_DIR)) + +from kdoc_files import KernelFiles # pylint: disable= =3DC0413 +from kdoc_output import RestFormat, ManFormat # pylint: disable= =3DC0413 + +DESC =3D """ +Read C language source or header FILEs, extract embedded documentation com= ments, +and print formatted documentation to standard output. + +The documentation comments are identified by the "/**" opening comment mar= k. + +See Documentation/doc-guide/kernel-doc.rst for the documentation comment s= yntax. +""" + +EXPORT_FILE_DESC =3D """ +Specify an additional FILE in which to look for EXPORT_SYMBOL information. + +May be used multiple times. +""" + +EXPORT_DESC =3D """ +Only output documentation for the symbols that have been +exported using EXPORT_SYMBOL() and related macros in any input +FILE or -export-file FILE. +""" + +INTERNAL_DESC =3D """ +Only output documentation for the symbols that have NOT been +exported using EXPORT_SYMBOL() and related macros in any input +FILE or -export-file FILE. +""" + +FUNCTION_DESC =3D """ +Only output documentation for the given function or DOC: section +title. All other functions and DOC: sections are ignored. + +May be used multiple times. +""" + +NOSYMBOL_DESC =3D """ +Exclude the specified symbol from the output documentation. + +May be used multiple times. +""" + +FILES_DESC =3D """ +Header and C source files to be parsed. +""" + +WARN_CONTENTS_BEFORE_SECTIONS_DESC =3D """ +Warns if there are contents before sections (deprecated). + +This option is kept just for backward-compatibility, but it does nothing, +neither here nor at the original Perl script. +""" + + +class MsgFormatter(logging.Formatter): + """Helper class to format warnings on a similar way to kernel-doc.pl""" + + def format(self, record): + record.levelname =3D record.levelname.capitalize() + return logging.Formatter.format(self, record) + +def main(): + """Main program""" + + parser =3D argparse.ArgumentParser(formatter_class=3Dargparse.RawTextH= elpFormatter, + description=3DDESC) + + # Normal arguments + + parser.add_argument("-v", "-verbose", "--verbose", action=3D"store_tru= e", + help=3D"Verbose output, more warnings and other in= formation.") + + parser.add_argument("-d", "-debug", "--debug", action=3D"store_true", + help=3D"Enable debug messages") + + parser.add_argument("-M", "-modulename", "--modulename", + default=3D"Kernel API", + help=3D"Allow setting a module name at the output.= ") + + parser.add_argument("-l", "-enable-lineno", "--enable_lineno", + action=3D"store_true", + help=3D"Enable line number output (only in ReST mo= de)") + + # Arguments to control the warning behavior + + parser.add_argument("-Wreturn", "--wreturn", action=3D"store_true", + help=3D"Warns about the lack of a return markup on= functions.") + + parser.add_argument("-Wshort-desc", "-Wshort-description", "--wshort-d= esc", + action=3D"store_true", + help=3D"Warns if initial short description is miss= ing") + + parser.add_argument("-Wcontents-before-sections", + "--wcontents-before-sections", action=3D"store_tru= e", + help=3DWARN_CONTENTS_BEFORE_SECTIONS_DESC) + + parser.add_argument("-Wall", "--wall", action=3D"store_true", + help=3D"Enable all types of warnings") + + parser.add_argument("-Werror", "--werror", action=3D"store_true", + help=3D"Treat warnings as errors.") + + parser.add_argument("-export-file", "--export-file", action=3D'append', + help=3DEXPORT_FILE_DESC) + + # Output format mutually-exclusive group + + out_group =3D parser.add_argument_group("Output format selection (mutu= ally exclusive)") + + out_fmt =3D out_group.add_mutually_exclusive_group() + + out_fmt.add_argument("-m", "-man", "--man", action=3D"store_true", + help=3D"Output troff manual page format.") + out_fmt.add_argument("-r", "-rst", "--rst", action=3D"store_true", + help=3D"Output reStructuredText format (default).= ") + out_fmt.add_argument("-N", "-none", "--none", action=3D"store_true", + help=3D"Do not output documentation, only warning= s.") + + # Output selection mutually-exclusive group + + sel_group =3D parser.add_argument_group("Output selection (mutually ex= clusive)") + sel_mut =3D sel_group.add_mutually_exclusive_group() + + sel_mut.add_argument("-e", "-export", "--export", action=3D'store_true= ', + help=3DEXPORT_DESC) + + sel_mut.add_argument("-i", "-internal", "--internal", action=3D'store_= true', + help=3DINTERNAL_DESC) + + sel_mut.add_argument("-s", "-function", "--symbol", action=3D'append', + help=3DFUNCTION_DESC) + + # Those are valid for all 3 types of filter + parser.add_argument("-n", "-nosymbol", "--nosymbol", action=3D'append', + help=3DNOSYMBOL_DESC) + + parser.add_argument("-D", "-no-doc-sections", "--no-doc-sections", + action=3D'store_true', help=3D"Don't outputt DOC s= ections") + + parser.add_argument("files", metavar=3D"FILE", + nargs=3D"+", help=3DFILES_DESC) + + args =3D parser.parse_args() + + if args.wall: + args.wreturn =3D True + args.wshort_desc =3D True + args.wcontents_before_sections =3D True + + logger =3D logging.getLogger() + + if not args.debug: + logger.setLevel(logging.INFO) + else: + logger.setLevel(logging.DEBUG) + + formatter =3D MsgFormatter('%(levelname)s: %(message)s') + + handler =3D logging.StreamHandler() + handler.setFormatter(formatter) + + logger.addHandler(handler) + + python_ver =3D sys.version_info[:2] + if python_ver < (3,6): + logger.warning("Python 3.6 or later is required by kernel-doc") + + # Return 0 here to avoid breaking compilation + sys.exit(0) + + if python_ver < (3,7): + logger.warning("Python 3.7 or later is required for correct result= s") + + if args.man: + out_style =3D ManFormat(modulename=3Dargs.modulename) + elif args.none: + out_style =3D None + else: + out_style =3D RestFormat() + + kfiles =3D KernelFiles(verbose=3Dargs.verbose, + out_style=3Dout_style, werror=3Dargs.werror, + wreturn=3Dargs.wreturn, wshort_desc=3Dargs.wshort= _desc, + wcontents_before_sections=3Dargs.wcontents_before= _sections) + + kfiles.parse(args.files, export_file=3Dargs.export_file) + + for t in kfiles.msg(enable_lineno=3Dargs.enable_lineno, export=3Dargs.= export, + internal=3Dargs.internal, symbol=3Dargs.symbol, + nosymbol=3Dargs.nosymbol, export_file=3Dargs.expor= t_file, + no_doc_sections=3Dargs.no_doc_sections): + msg =3D t[1] + if msg: + print(msg) + + error_count =3D kfiles.errors + if not error_count: + sys.exit(0) + + if args.werror: + print(f"{error_count} warnings as errors") + sys.exit(error_count) + + if args.verbose: + print(f"{error_count} errors") + + if args.none: + sys.exit(0) + + sys.exit(error_count) + + +# Call main method +if __name__ =3D=3D "__main__": + main() diff --git a/scripts/lib/kdoc/kdoc_files.py b/scripts/lib/kdoc/kdoc_files.py new file mode 100644 index 00000000000..9e09b45b02f --- /dev/null +++ b/scripts/lib/kdoc/kdoc_files.py @@ -0,0 +1,291 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0 +# Copyright(c) 2025: Mauro Carvalho Chehab . +# +# pylint: disable=3DR0903,R0913,R0914,R0917 + +""" +Parse lernel-doc tags on multiple kernel source files. +""" + +import argparse +import logging +import os +import re + +from kdoc_parser import KernelDoc +from kdoc_output import OutputFormat + + +class GlobSourceFiles: + """ + Parse C source code file names and directories via an Interactor. + """ + + def __init__(self, srctree=3DNone, valid_extensions=3DNone): + """ + Initialize valid extensions with a tuple. + + If not defined, assume default C extensions (.c and .h) + + It would be possible to use python's glob function, but it is + very slow, and it is not interactive. So, it would wait to read all + directories before actually do something. + + So, let's use our own implementation. + """ + + if not valid_extensions: + self.extensions =3D (".c", ".h") + else: + self.extensions =3D valid_extensions + + self.srctree =3D srctree + + def _parse_dir(self, dirname): + """Internal function to parse files recursively""" + + with os.scandir(dirname) as obj: + for entry in obj: + name =3D os.path.join(dirname, entry.name) + + if entry.is_dir(): + yield from self._parse_dir(name) + + if not entry.is_file(): + continue + + basename =3D os.path.basename(name) + + if not basename.endswith(self.extensions): + continue + + yield name + + def parse_files(self, file_list, file_not_found_cb): + """ + Define an interator to parse all source files from file_list, + handling directories if any + """ + + if not file_list: + return + + for fname in file_list: + if self.srctree: + f =3D os.path.join(self.srctree, fname) + else: + f =3D fname + + if os.path.isdir(f): + yield from self._parse_dir(f) + elif os.path.isfile(f): + yield f + elif file_not_found_cb: + file_not_found_cb(fname) + + +class KernelFiles(): + """ + Parse kernel-doc tags on multiple kernel source files. + + There are two type of parsers defined here: + - self.parse_file(): parses both kernel-doc markups and + EXPORT_SYMBOL* macros; + - self.process_export_file(): parses only EXPORT_SYMBOL* macros. + """ + + def warning(self, msg): + """Ancillary routine to output a warning and increment error count= """ + + self.config.log.warning(msg) + self.errors +=3D 1 + + def error(self, msg): + """Ancillary routine to output an error and increment error count"= "" + + self.config.log.error(msg) + self.errors +=3D 1 + + def parse_file(self, fname): + """ + Parse a single Kernel source. + """ + + # Prevent parsing the same file twice if results are cached + if fname in self.files: + return + + doc =3D KernelDoc(self.config, fname) + export_table, entries =3D doc.parse_kdoc() + + self.export_table[fname] =3D export_table + + self.files.add(fname) + self.export_files.add(fname) # parse_kdoc() already check exp= orts + + self.results[fname] =3D entries + + def process_export_file(self, fname): + """ + Parses EXPORT_SYMBOL* macros from a single Kernel source file. + """ + + # Prevent parsing the same file twice if results are cached + if fname in self.export_files: + return + + doc =3D KernelDoc(self.config, fname) + export_table =3D doc.parse_export() + + if not export_table: + self.error(f"Error: Cannot check EXPORT_SYMBOL* on {fname}") + export_table =3D set() + + self.export_table[fname] =3D export_table + self.export_files.add(fname) + + def file_not_found_cb(self, fname): + """ + Callback to warn if a file was not found. + """ + + self.error(f"Cannot find file {fname}") + + def __init__(self, verbose=3DFalse, out_style=3DNone, + werror=3DFalse, wreturn=3DFalse, wshort_desc=3DFalse, + wcontents_before_sections=3DFalse, + logger=3DNone): + """ + Initialize startup variables and parse all files + """ + + if not verbose: + verbose =3D bool(os.environ.get("KBUILD_VERBOSE", 0)) + + if out_style is None: + out_style =3D OutputFormat() + + if not werror: + kcflags =3D os.environ.get("KCFLAGS", None) + if kcflags: + match =3D re.search(r"(\s|^)-Werror(\s|$)/", kcflags) + if match: + werror =3D True + + # reading this variable is for backwards compat just in case + # someone was calling it with the variable from outside the + # kernel's build system + kdoc_werror =3D os.environ.get("KDOC_WERROR", None) + if kdoc_werror: + werror =3D kdoc_werror + + # Some variables are global to the parser logic as a whole as they= are + # used to send control configuration to KernelDoc class. As such, + # those variables are read-only inside the KernelDoc. + self.config =3D argparse.Namespace + + self.config.verbose =3D verbose + self.config.werror =3D werror + self.config.wreturn =3D wreturn + self.config.wshort_desc =3D wshort_desc + self.config.wcontents_before_sections =3D wcontents_before_sections + + if not logger: + self.config.log =3D logging.getLogger("kernel-doc") + else: + self.config.log =3D logger + + self.config.warning =3D self.warning + + self.config.src_tree =3D os.environ.get("SRCTREE", None) + + # Initialize variables that are internal to KernelFiles + + self.out_style =3D out_style + + self.errors =3D 0 + self.results =3D {} + + self.files =3D set() + self.export_files =3D set() + self.export_table =3D {} + + def parse(self, file_list, export_file=3DNone): + """ + Parse all files + """ + + glob =3D GlobSourceFiles(srctree=3Dself.config.src_tree) + + for fname in glob.parse_files(file_list, self.file_not_found_cb): + self.parse_file(fname) + + for fname in glob.parse_files(export_file, self.file_not_found_cb): + self.process_export_file(fname) + + def out_msg(self, fname, name, arg): + """ + Return output messages from a file name using the output style + filtering. + + If output type was not handled by the syler, return None. + """ + + # NOTE: we can add rules here to filter out unwanted parts, + # although OutputFormat.msg already does that. + + return self.out_style.msg(fname, name, arg) + + def msg(self, enable_lineno=3DFalse, export=3DFalse, internal=3DFalse, + symbol=3DNone, nosymbol=3DNone, no_doc_sections=3DFalse, + filenames=3DNone, export_file=3DNone): + """ + Interacts over the kernel-doc results and output messages, + returning kernel-doc markups on each interaction + """ + + self.out_style.set_config(self.config) + + if not filenames: + filenames =3D sorted(self.results.keys()) + + glob =3D GlobSourceFiles(srctree=3Dself.config.src_tree) + + for fname in filenames: + function_table =3D set() + + if internal or export: + if not export_file: + export_file =3D [fname] + + for f in glob.parse_files(export_file, self.file_not_found= _cb): + function_table |=3D self.export_table[f] + + if symbol: + for s in symbol: + function_table.add(s) + + self.out_style.set_filter(export, internal, symbol, nosymbol, + function_table, enable_lineno, + no_doc_sections) + + msg =3D "" + if fname not in self.results: + self.config.log.warning("No kernel-doc for file %s", fname) + continue + + for arg in self.results[fname]: + m =3D self.out_msg(fname, arg.name, arg) + + if m is None: + ln =3D arg.get("ln", 0) + dtype =3D arg.get('type', "") + + self.config.log.warning("%s:%d Can't handle %s", + fname, ln, dtype) + else: + msg +=3D m + + if msg: + yield fname, msg diff --git a/scripts/lib/kdoc/kdoc_item.py b/scripts/lib/kdoc/kdoc_item.py new file mode 100644 index 00000000000..b3b22576455 --- /dev/null +++ b/scripts/lib/kdoc/kdoc_item.py @@ -0,0 +1,42 @@ +# SPDX-License-Identifier: GPL-2.0 +# +# A class that will, eventually, encapsulate all of the parsed data that we +# then pass into the output modules. +# + +class KdocItem: + def __init__(self, name, type, start_line, **other_stuff): + self.name =3D name + self.type =3D type + self.declaration_start_line =3D start_line + self.sections =3D {} + self.sections_start_lines =3D {} + self.parameterlist =3D [] + self.parameterdesc_start_lines =3D [] + self.parameterdescs =3D {} + self.parametertypes =3D {} + # + # Just save everything else into our own dict so that the output + # side can grab it directly as before. As we move things into more + # structured data, this will, hopefully, fade away. + # + self.other_stuff =3D other_stuff + + def get(self, key, default =3D None): + return self.other_stuff.get(key, default) + + def __getitem__(self, key): + return self.get(key) + + # + # Tracking of section and parameter information. + # + def set_sections(self, sections, start_lines): + self.sections =3D sections + self.section_start_lines =3D start_lines + + def set_params(self, names, descs, types, starts): + self.parameterlist =3D names + self.parameterdescs =3D descs + self.parametertypes =3D types + self.parameterdesc_start_lines =3D starts diff --git a/scripts/lib/kdoc/kdoc_output.py b/scripts/lib/kdoc/kdoc_output= .py new file mode 100644 index 00000000000..ea8914537ba --- /dev/null +++ b/scripts/lib/kdoc/kdoc_output.py @@ -0,0 +1,749 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0 +# Copyright(c) 2025: Mauro Carvalho Chehab . +# +# pylint: disable=3DC0301,R0902,R0911,R0912,R0913,R0914,R0915,R0917 + +""" +Implement output filters to print kernel-doc documentation. + +The implementation uses a virtual base class (OutputFormat) which +contains a dispatches to virtual methods, and some code to filter +out output messages. + +The actual implementation is done on one separate class per each type +of output. Currently, there are output classes for ReST and man/troff. +""" + +import os +import re +from datetime import datetime + +from kdoc_parser import KernelDoc, type_param +from kdoc_re import KernRe + + +function_pointer =3D KernRe(r"([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)", cache=3DF= alse) + +# match expressions used to find embedded type information +type_constant =3D KernRe(r"\b``([^\`]+)``\b", cache=3DFalse) +type_constant2 =3D KernRe(r"\%([-_*\w]+)", cache=3DFalse) +type_func =3D KernRe(r"(\w+)\(\)", cache=3DFalse) +type_param_ref =3D KernRe(r"([\!~\*]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)",= cache=3DFalse) + +# Special RST handling for func ptr params +type_fp_param =3D KernRe(r"\@(\w+)\(\)", cache=3DFalse) + +# Special RST handling for structs with func ptr params +type_fp_param2 =3D KernRe(r"\@(\w+->\S+)\(\)", cache=3DFalse) + +type_env =3D KernRe(r"(\$\w+)", cache=3DFalse) +type_enum =3D KernRe(r"\&(enum\s*([_\w]+))", cache=3DFalse) +type_struct =3D KernRe(r"\&(struct\s*([_\w]+))", cache=3DFalse) +type_typedef =3D KernRe(r"\&(typedef\s*([_\w]+))", cache=3DFalse) +type_union =3D KernRe(r"\&(union\s*([_\w]+))", cache=3DFalse) +type_member =3D KernRe(r"\&([_\w]+)(\.|->)([_\w]+)", cache=3DFalse) +type_fallback =3D KernRe(r"\&([_\w]+)", cache=3DFalse) +type_member_func =3D type_member + KernRe(r"\(\)", cache=3DFalse) + + +class OutputFormat: + """ + Base class for OutputFormat. If used as-is, it means that only + warnings will be displayed. + """ + + # output mode. + OUTPUT_ALL =3D 0 # output all symbols and doc sections + OUTPUT_INCLUDE =3D 1 # output only specified symbols + OUTPUT_EXPORTED =3D 2 # output exported symbols + OUTPUT_INTERNAL =3D 3 # output non-exported symbols + + # Virtual member to be overriden at the inherited classes + highlights =3D [] + + def __init__(self): + """Declare internal vars and set mode to OUTPUT_ALL""" + + self.out_mode =3D self.OUTPUT_ALL + self.enable_lineno =3D None + self.nosymbol =3D {} + self.symbol =3D None + self.function_table =3D None + self.config =3D None + self.no_doc_sections =3D False + + self.data =3D "" + + def set_config(self, config): + """ + Setup global config variables used by both parser and output. + """ + + self.config =3D config + + def set_filter(self, export, internal, symbol, nosymbol, function_tabl= e, + enable_lineno, no_doc_sections): + """ + Initialize filter variables according with the requested mode. + + Only one choice is valid between export, internal and symbol. + + The nosymbol filter can be used on all modes. + """ + + self.enable_lineno =3D enable_lineno + self.no_doc_sections =3D no_doc_sections + self.function_table =3D function_table + + if symbol: + self.out_mode =3D self.OUTPUT_INCLUDE + elif export: + self.out_mode =3D self.OUTPUT_EXPORTED + elif internal: + self.out_mode =3D self.OUTPUT_INTERNAL + else: + self.out_mode =3D self.OUTPUT_ALL + + if nosymbol: + self.nosymbol =3D set(nosymbol) + + + def highlight_block(self, block): + """ + Apply the RST highlights to a sub-block of text. + """ + + for r, sub in self.highlights: + block =3D r.sub(sub, block) + + return block + + def out_warnings(self, args): + """ + Output warnings for identifiers that will be displayed. + """ + + for log_msg in args.warnings: + self.config.warning(log_msg) + + def check_doc(self, name, args): + """Check if DOC should be output""" + + if self.no_doc_sections: + return False + + if name in self.nosymbol: + return False + + if self.out_mode =3D=3D self.OUTPUT_ALL: + self.out_warnings(args) + return True + + if self.out_mode =3D=3D self.OUTPUT_INCLUDE: + if name in self.function_table: + self.out_warnings(args) + return True + + return False + + def check_declaration(self, dtype, name, args): + """ + Checks if a declaration should be output or not based on the + filtering criteria. + """ + + if name in self.nosymbol: + return False + + if self.out_mode =3D=3D self.OUTPUT_ALL: + self.out_warnings(args) + return True + + if self.out_mode in [self.OUTPUT_INCLUDE, self.OUTPUT_EXPORTED]: + if name in self.function_table: + return True + + if self.out_mode =3D=3D self.OUTPUT_INTERNAL: + if dtype !=3D "function": + self.out_warnings(args) + return True + + if name not in self.function_table: + self.out_warnings(args) + return True + + return False + + def msg(self, fname, name, args): + """ + Handles a single entry from kernel-doc parser + """ + + self.data =3D "" + + dtype =3D args.type + + if dtype =3D=3D "doc": + self.out_doc(fname, name, args) + return self.data + + if not self.check_declaration(dtype, name, args): + return self.data + + if dtype =3D=3D "function": + self.out_function(fname, name, args) + return self.data + + if dtype =3D=3D "enum": + self.out_enum(fname, name, args) + return self.data + + if dtype =3D=3D "typedef": + self.out_typedef(fname, name, args) + return self.data + + if dtype in ["struct", "union"]: + self.out_struct(fname, name, args) + return self.data + + # Warn if some type requires an output logic + self.config.log.warning("doesn't now how to output '%s' block", + dtype) + + return None + + # Virtual methods to be overridden by inherited classes + # At the base class, those do nothing. + def out_doc(self, fname, name, args): + """Outputs a DOC block""" + + def out_function(self, fname, name, args): + """Outputs a function""" + + def out_enum(self, fname, name, args): + """Outputs an enum""" + + def out_typedef(self, fname, name, args): + """Outputs a typedef""" + + def out_struct(self, fname, name, args): + """Outputs a struct""" + + +class RestFormat(OutputFormat): + """Consts and functions used by ReST output""" + + highlights =3D [ + (type_constant, r"``\1``"), + (type_constant2, r"``\1``"), + + # Note: need to escape () to avoid func matching later + (type_member_func, r":c:type:`\1\2\3\\(\\) <\1>`"), + (type_member, r":c:type:`\1\2\3 <\1>`"), + (type_fp_param, r"**\1\\(\\)**"), + (type_fp_param2, r"**\1\\(\\)**"), + (type_func, r"\1()"), + (type_enum, r":c:type:`\1 <\2>`"), + (type_struct, r":c:type:`\1 <\2>`"), + (type_typedef, r":c:type:`\1 <\2>`"), + (type_union, r":c:type:`\1 <\2>`"), + + # in rst this can refer to any type + (type_fallback, r":c:type:`\1`"), + (type_param_ref, r"**\1\2**") + ] + blankline =3D "\n" + + sphinx_literal =3D KernRe(r'^[^.].*::$', cache=3DFalse) + sphinx_cblock =3D KernRe(r'^\.\.\ +code-block::', cache=3DFalse) + + def __init__(self): + """ + Creates class variables. + + Not really mandatory, but it is a good coding style and makes + pylint happy. + """ + + super().__init__() + self.lineprefix =3D "" + + def print_lineno(self, ln): + """Outputs a line number""" + + if self.enable_lineno and ln is not None: + ln +=3D 1 + self.data +=3D f".. LINENO {ln}\n" + + def output_highlight(self, args): + """ + Outputs a C symbol that may require being converted to ReST using + the self.highlights variable + """ + + input_text =3D args + output =3D "" + in_literal =3D False + litprefix =3D "" + block =3D "" + + for line in input_text.strip("\n").split("\n"): + + # If we're in a literal block, see if we should drop out of it. + # Otherwise, pass the line straight through unmunged. + if in_literal: + if line.strip(): # If the line is not blank + # If this is the first non-blank line in a literal blo= ck, + # figure out the proper indent. + if not litprefix: + r =3D KernRe(r'^(\s*)') + if r.match(line): + litprefix =3D '^' + r.group(1) + else: + litprefix =3D "" + + output +=3D line + "\n" + elif not KernRe(litprefix).match(line): + in_literal =3D False + else: + output +=3D line + "\n" + else: + output +=3D line + "\n" + + # Not in a literal block (or just dropped out) + if not in_literal: + block +=3D line + "\n" + if self.sphinx_literal.match(line) or self.sphinx_cblock.m= atch(line): + in_literal =3D True + litprefix =3D "" + output +=3D self.highlight_block(block) + block =3D "" + + # Handle any remaining block + if block: + output +=3D self.highlight_block(block) + + # Print the output with the line prefix + for line in output.strip("\n").split("\n"): + self.data +=3D self.lineprefix + line + "\n" + + def out_section(self, args, out_docblock=3DFalse): + """ + Outputs a block section. + + This could use some work; it's used to output the DOC: sections, a= nd + starts by putting out the name of the doc section itself, but that + tends to duplicate a header already in the template file. + """ + for section, text in args.sections.items(): + # Skip sections that are in the nosymbol_table + if section in self.nosymbol: + continue + + if out_docblock: + if not self.out_mode =3D=3D self.OUTPUT_INCLUDE: + self.data +=3D f".. _{section}:\n\n" + self.data +=3D f'{self.lineprefix}**{section}**\n\n' + else: + self.data +=3D f'{self.lineprefix}**{section}**\n\n' + + self.print_lineno(args.section_start_lines.get(section, 0)) + self.output_highlight(text) + self.data +=3D "\n" + self.data +=3D "\n" + + def out_doc(self, fname, name, args): + if not self.check_doc(name, args): + return + self.out_section(args, out_docblock=3DTrue) + + def out_function(self, fname, name, args): + + oldprefix =3D self.lineprefix + signature =3D "" + + func_macro =3D args.get('func_macro', False) + if func_macro: + signature =3D name + else: + if args.get('functiontype'): + signature =3D args['functiontype'] + " " + signature +=3D name + " (" + + ln =3D args.declaration_start_line + count =3D 0 + for parameter in args.parameterlist: + if count !=3D 0: + signature +=3D ", " + count +=3D 1 + dtype =3D args.parametertypes.get(parameter, "") + + if function_pointer.search(dtype): + signature +=3D function_pointer.group(1) + parameter + fun= ction_pointer.group(3) + else: + signature +=3D dtype + + if not func_macro: + signature +=3D ")" + + self.print_lineno(ln) + if args.get('typedef') or not args.get('functiontype'): + self.data +=3D f".. c:macro:: {name}\n\n" + + if args.get('typedef'): + self.data +=3D " **Typedef**: " + self.lineprefix =3D "" + self.output_highlight(args.get('purpose', "")) + self.data +=3D "\n\n**Syntax**\n\n" + self.data +=3D f" ``{signature}``\n\n" + else: + self.data +=3D f"``{signature}``\n\n" + else: + self.data +=3D f".. c:function:: {signature}\n\n" + + if not args.get('typedef'): + self.print_lineno(ln) + self.lineprefix =3D " " + self.output_highlight(args.get('purpose', "")) + self.data +=3D "\n" + + # Put descriptive text into a container (HTML
) to help set + # function prototypes apart + self.lineprefix =3D " " + + if args.parameterlist: + self.data +=3D ".. container:: kernelindent\n\n" + self.data +=3D f"{self.lineprefix}**Parameters**\n\n" + + for parameter in args.parameterlist: + parameter_name =3D KernRe(r'\[.*').sub('', parameter) + dtype =3D args.parametertypes.get(parameter, "") + + if dtype: + self.data +=3D f"{self.lineprefix}``{dtype}``\n" + else: + self.data +=3D f"{self.lineprefix}``{parameter}``\n" + + self.print_lineno(args.parameterdesc_start_lines.get(parameter= _name, 0)) + + self.lineprefix =3D " " + if parameter_name in args.parameterdescs and \ + args.parameterdescs[parameter_name] !=3D KernelDoc.undescri= bed: + + self.output_highlight(args.parameterdescs[parameter_name]) + self.data +=3D "\n" + else: + self.data +=3D f"{self.lineprefix}*undescribed*\n\n" + self.lineprefix =3D " " + + self.out_section(args) + self.lineprefix =3D oldprefix + + def out_enum(self, fname, name, args): + + oldprefix =3D self.lineprefix + ln =3D args.declaration_start_line + + self.data +=3D f"\n\n.. c:enum:: {name}\n\n" + + self.print_lineno(ln) + self.lineprefix =3D " " + self.output_highlight(args.get('purpose', '')) + self.data +=3D "\n" + + self.data +=3D ".. container:: kernelindent\n\n" + outer =3D self.lineprefix + " " + self.lineprefix =3D outer + " " + self.data +=3D f"{outer}**Constants**\n\n" + + for parameter in args.parameterlist: + self.data +=3D f"{outer}``{parameter}``\n" + + if args.parameterdescs.get(parameter, '') !=3D KernelDoc.undes= cribed: + self.output_highlight(args.parameterdescs[parameter]) + else: + self.data +=3D f"{self.lineprefix}*undescribed*\n\n" + self.data +=3D "\n" + + self.lineprefix =3D oldprefix + self.out_section(args) + + def out_typedef(self, fname, name, args): + + oldprefix =3D self.lineprefix + ln =3D args.declaration_start_line + + self.data +=3D f"\n\n.. c:type:: {name}\n\n" + + self.print_lineno(ln) + self.lineprefix =3D " " + + self.output_highlight(args.get('purpose', '')) + + self.data +=3D "\n" + + self.lineprefix =3D oldprefix + self.out_section(args) + + def out_struct(self, fname, name, args): + + purpose =3D args.get('purpose', "") + declaration =3D args.get('definition', "") + dtype =3D args.type + ln =3D args.declaration_start_line + + self.data +=3D f"\n\n.. c:{dtype}:: {name}\n\n" + + self.print_lineno(ln) + + oldprefix =3D self.lineprefix + self.lineprefix +=3D " " + + self.output_highlight(purpose) + self.data +=3D "\n" + + self.data +=3D ".. container:: kernelindent\n\n" + self.data +=3D f"{self.lineprefix}**Definition**::\n\n" + + self.lineprefix =3D self.lineprefix + " " + + declaration =3D declaration.replace("\t", self.lineprefix) + + self.data +=3D f"{self.lineprefix}{dtype} {name}" + ' {' + "\n" + self.data +=3D f"{declaration}{self.lineprefix}" + "};\n\n" + + self.lineprefix =3D " " + self.data +=3D f"{self.lineprefix}**Members**\n\n" + for parameter in args.parameterlist: + if not parameter or parameter.startswith("#"): + continue + + parameter_name =3D parameter.split("[", maxsplit=3D1)[0] + + if args.parameterdescs.get(parameter_name) =3D=3D KernelDoc.un= described: + continue + + self.print_lineno(args.parameterdesc_start_lines.get(parameter= _name, 0)) + + self.data +=3D f"{self.lineprefix}``{parameter}``\n" + + self.lineprefix =3D " " + self.output_highlight(args.parameterdescs[parameter_name]) + self.lineprefix =3D " " + + self.data +=3D "\n" + + self.data +=3D "\n" + + self.lineprefix =3D oldprefix + self.out_section(args) + + +class ManFormat(OutputFormat): + """Consts and functions used by man pages output""" + + highlights =3D ( + (type_constant, r"\1"), + (type_constant2, r"\1"), + (type_func, r"\\fB\1\\fP"), + (type_enum, r"\\fI\1\\fP"), + (type_struct, r"\\fI\1\\fP"), + (type_typedef, r"\\fI\1\\fP"), + (type_union, r"\\fI\1\\fP"), + (type_param, r"\\fI\1\\fP"), + (type_param_ref, r"\\fI\1\2\\fP"), + (type_member, r"\\fI\1\2\3\\fP"), + (type_fallback, r"\\fI\1\\fP") + ) + blankline =3D "" + + date_formats =3D [ + "%a %b %d %H:%M:%S %Z %Y", + "%a %b %d %H:%M:%S %Y", + "%Y-%m-%d", + "%b %d %Y", + "%B %d %Y", + "%m %d %Y", + ] + + def __init__(self, modulename): + """ + Creates class variables. + + Not really mandatory, but it is a good coding style and makes + pylint happy. + """ + + super().__init__() + self.modulename =3D modulename + + dt =3D None + tstamp =3D os.environ.get("KBUILD_BUILD_TIMESTAMP") + if tstamp: + for fmt in self.date_formats: + try: + dt =3D datetime.strptime(tstamp, fmt) + break + except ValueError: + pass + + if not dt: + dt =3D datetime.now() + + self.man_date =3D dt.strftime("%B %Y") + + def output_highlight(self, block): + """ + Outputs a C symbol that may require being highlighted with + self.highlights variable using troff syntax + """ + + contents =3D self.highlight_block(block) + + if isinstance(contents, list): + contents =3D "\n".join(contents) + + for line in contents.strip("\n").split("\n"): + line =3D KernRe(r"^\s*").sub("", line) + if not line: + continue + + if line[0] =3D=3D ".": + self.data +=3D "\\&" + line + "\n" + else: + self.data +=3D line + "\n" + + def out_doc(self, fname, name, args): + if not self.check_doc(name, args): + return + + self.data +=3D f'.TH "{self.modulename}" 9 "{self.modulename}" "{s= elf.man_date}" "API Manual" LINUX' + "\n" + + for section, text in args.sections.items(): + self.data +=3D f'.SH "{section}"' + "\n" + self.output_highlight(text) + + def out_function(self, fname, name, args): + """output function in man""" + + self.data +=3D f'.TH "{name}" 9 "{name}" "{self.man_date}" "Kernel= Hacker\'s Manual" LINUX' + "\n" + + self.data +=3D ".SH NAME\n" + self.data +=3D f"{name} \\- {args['purpose']}\n" + + self.data +=3D ".SH SYNOPSIS\n" + if args.get('functiontype', ''): + self.data +=3D f'.B "{args["functiontype"]}" {name}' + "\n" + else: + self.data +=3D f'.B "{name}' + "\n" + + count =3D 0 + parenth =3D "(" + post =3D "," + + for parameter in args.parameterlist: + if count =3D=3D len(args.parameterlist) - 1: + post =3D ");" + + dtype =3D args.parametertypes.get(parameter, "") + if function_pointer.match(dtype): + # Pointer-to-function + self.data +=3D f'".BI "{parenth}{function_pointer.group(1)= }" " ") ({function_pointer.group(2)}){post}"' + "\n" + else: + dtype =3D KernRe(r'([^\*])$').sub(r'\1 ', dtype) + + self.data +=3D f'.BI "{parenth}{dtype}" "{post}"' + "\n" + count +=3D 1 + parenth =3D "" + + if args.parameterlist: + self.data +=3D ".SH ARGUMENTS\n" + + for parameter in args.parameterlist: + parameter_name =3D re.sub(r'\[.*', '', parameter) + + self.data +=3D f'.IP "{parameter}" 12' + "\n" + self.output_highlight(args.parameterdescs.get(parameter_name, = "")) + + for section, text in args.sections.items(): + self.data +=3D f'.SH "{section.upper()}"' + "\n" + self.output_highlight(text) + + def out_enum(self, fname, name, args): + self.data +=3D f'.TH "{self.modulename}" 9 "enum {name}" "{self.ma= n_date}" "API Manual" LINUX' + "\n" + + self.data +=3D ".SH NAME\n" + self.data +=3D f"enum {name} \\- {args['purpose']}\n" + + self.data +=3D ".SH SYNOPSIS\n" + self.data +=3D f"enum {name}" + " {\n" + + count =3D 0 + for parameter in args.parameterlist: + self.data +=3D f'.br\n.BI " {parameter}"' + "\n" + if count =3D=3D len(args.parameterlist) - 1: + self.data +=3D "\n};\n" + else: + self.data +=3D ", \n.br\n" + + count +=3D 1 + + self.data +=3D ".SH Constants\n" + + for parameter in args.parameterlist: + parameter_name =3D KernRe(r'\[.*').sub('', parameter) + self.data +=3D f'.IP "{parameter}" 12' + "\n" + self.output_highlight(args.parameterdescs.get(parameter_name, = "")) + + for section, text in args.sections.items(): + self.data +=3D f'.SH "{section}"' + "\n" + self.output_highlight(text) + + def out_typedef(self, fname, name, args): + module =3D self.modulename + purpose =3D args.get('purpose') + + self.data +=3D f'.TH "{module}" 9 "{name}" "{self.man_date}" "API = Manual" LINUX' + "\n" + + self.data +=3D ".SH NAME\n" + self.data +=3D f"typedef {name} \\- {purpose}\n" + + for section, text in args.sections.items(): + self.data +=3D f'.SH "{section}"' + "\n" + self.output_highlight(text) + + def out_struct(self, fname, name, args): + module =3D self.modulename + purpose =3D args.get('purpose') + definition =3D args.get('definition') + + self.data +=3D f'.TH "{module}" 9 "{args.type} {name}" "{self.man_= date}" "API Manual" LINUX' + "\n" + + self.data +=3D ".SH NAME\n" + self.data +=3D f"{args.type} {name} \\- {purpose}\n" + + # Replace tabs with two spaces and handle newlines + declaration =3D definition.replace("\t", " ") + declaration =3D KernRe(r"\n").sub('"\n.br\n.BI "', declaration) + + self.data +=3D ".SH SYNOPSIS\n" + self.data +=3D f"{args.type} {name} " + "{" + "\n.br\n" + self.data +=3D f'.BI "{declaration}\n' + "};\n.br\n\n" + + self.data +=3D ".SH Members\n" + for parameter in args.parameterlist: + if parameter.startswith("#"): + continue + + parameter_name =3D re.sub(r"\[.*", "", parameter) + + if args.parameterdescs.get(parameter_name) =3D=3D KernelDoc.un= described: + continue + + self.data +=3D f'.IP "{parameter}" 12' + "\n" + self.output_highlight(args.parameterdescs.get(parameter_name)) + + for section, text in args.sections.items(): + self.data +=3D f'.SH "{section}"' + "\n" + self.output_highlight(text) diff --git a/scripts/lib/kdoc/kdoc_parser.py b/scripts/lib/kdoc/kdoc_parser= .py new file mode 100644 index 00000000000..fe730099eca --- /dev/null +++ b/scripts/lib/kdoc/kdoc_parser.py @@ -0,0 +1,1669 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0 +# Copyright(c) 2025: Mauro Carvalho Chehab . +# +# pylint: disable=3DC0301,C0302,R0904,R0912,R0913,R0914,R0915,R0917,R1702 + +""" +kdoc_parser +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Read a C language source or header FILE and extract embedded +documentation comments +""" + +import sys +import re +from pprint import pformat + +from kdoc_re import NestedMatch, KernRe +from kdoc_item import KdocItem + +# +# Regular expressions used to parse kernel-doc markups at KernelDoc class. +# +# Let's declare them in lowercase outside any class to make easier to +# convert from the python script. +# +# As those are evaluated at the beginning, no need to cache them +# + +# Allow whitespace at end of comment start. +doc_start =3D KernRe(r'^/\*\*\s*$', cache=3DFalse) + +doc_end =3D KernRe(r'\*/', cache=3DFalse) +doc_com =3D KernRe(r'\s*\*\s*', cache=3DFalse) +doc_com_body =3D KernRe(r'\s*\* ?', cache=3DFalse) +doc_decl =3D doc_com + KernRe(r'(\w+)', cache=3DFalse) + +# @params and a strictly limited set of supported section names +# Specifically: +# Match @word: +# @...: +# @{section-name}: +# while trying to not match literal block starts like "example::" +# +known_section_names =3D 'description|context|returns?|notes?|examples?' +known_sections =3D KernRe(known_section_names, flags =3D re.I) +doc_sect =3D doc_com + \ + KernRe(r'\s*(\@[.\w]+|\@\.\.\.|' + known_section_names + r')\s*:([^:].= *)?$', + flags=3Dre.I, cache=3DFalse) + +doc_content =3D doc_com_body + KernRe(r'(.*)', cache=3DFalse) +doc_inline_start =3D KernRe(r'^\s*/\*\*\s*$', cache=3DFalse) +doc_inline_sect =3D KernRe(r'\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)', cache=3DF= alse) +doc_inline_end =3D KernRe(r'^\s*\*/\s*$', cache=3DFalse) +doc_inline_oneline =3D KernRe(r'^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$',= cache=3DFalse) +attribute =3D KernRe(r"__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)", + flags=3Dre.I | re.S, cache=3DFalse) + +export_symbol =3D KernRe(r'^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*',= cache=3DFalse) +export_symbol_ns =3D KernRe(r'^\s*EXPORT_SYMBOL_NS(_GPL)?\s*\(\s*(\w+)\s*,= \s*"\S+"\)\s*', cache=3DFalse) + +type_param =3D KernRe(r"\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)", cache=3DFalse) + +# +# Tests for the beginning of a kerneldoc block in its various forms. +# +doc_block =3D doc_com + KernRe(r'DOC:\s*(.*)?', cache=3DFalse) +doc_begin_data =3D KernRe(r"^\s*\*?\s*(struct|union|enum|typedef)\b\s*(\w*= )", cache =3D False) +doc_begin_func =3D KernRe(str(doc_com) + # initial " * ' + r"(?:\w+\s*\*\s*)?" + # type (not captured) + r'(?:define\s+)?' + # possible "define" (not cap= tured) + r'(\w+)\s*(?:\(\w*\))?\s*' + # name and optional "= (...)" + r'(?:[-:].*)?$', # description (not captured) + cache =3D False) + +# +# A little helper to get rid of excess white space +# +multi_space =3D KernRe(r'\s\s+') +def trim_whitespace(s): + return multi_space.sub(' ', s.strip()) + +class state: + """ + State machine enums + """ + + # Parser states + NORMAL =3D 0 # normal code + NAME =3D 1 # looking for function name + DECLARATION =3D 2 # We have seen a declaration which might no= t be done + BODY =3D 3 # the body of the comment + SPECIAL_SECTION =3D 4 # doc section ending with a blank line + PROTO =3D 5 # scanning prototype + DOCBLOCK =3D 6 # documentation block + INLINE_NAME =3D 7 # gathering doc outside main block + INLINE_TEXT =3D 8 # reading the body of inline docs + + name =3D [ + "NORMAL", + "NAME", + "DECLARATION", + "BODY", + "SPECIAL_SECTION", + "PROTO", + "DOCBLOCK", + "INLINE_NAME", + "INLINE_TEXT", + ] + + +SECTION_DEFAULT =3D "Description" # default section + +class KernelEntry: + + def __init__(self, config, ln): + self.config =3D config + + self._contents =3D [] + self.prototype =3D "" + + self.warnings =3D [] + + self.parameterlist =3D [] + self.parameterdescs =3D {} + self.parametertypes =3D {} + self.parameterdesc_start_lines =3D {} + + self.section_start_lines =3D {} + self.sections =3D {} + + self.anon_struct_union =3D False + + self.leading_space =3D None + + # State flags + self.brcount =3D 0 + self.declaration_start_line =3D ln + 1 + + # + # Management of section contents + # + def add_text(self, text): + self._contents.append(text) + + def contents(self): + return '\n'.join(self._contents) + '\n' + + # TODO: rename to emit_message after removal of kernel-doc.pl + def emit_msg(self, log_msg, warning=3DTrue): + """Emit a message""" + + if not warning: + self.config.log.info(log_msg) + return + + # Delegate warning output to output logic, as this way it + # will report warnings/info only for symbols that are output + + self.warnings.append(log_msg) + return + + # + # Begin a new section. + # + def begin_section(self, line_no, title =3D SECTION_DEFAULT, dump =3D F= alse): + if dump: + self.dump_section(start_new =3D True) + self.section =3D title + self.new_start_line =3D line_no + + def dump_section(self, start_new=3DTrue): + """ + Dumps section contents to arrays/hashes intended for that purpose. + """ + # + # If we have accumulated no contents in the default ("description") + # section, don't bother. + # + if self.section =3D=3D SECTION_DEFAULT and not self._contents: + return + name =3D self.section + contents =3D self.contents() + + if type_param.match(name): + name =3D type_param.group(1) + + self.parameterdescs[name] =3D contents + self.parameterdesc_start_lines[name] =3D self.new_start_line + + self.new_start_line =3D 0 + + else: + if name in self.sections and self.sections[name] !=3D "": + # Only warn on user-specified duplicate section names + if name !=3D SECTION_DEFAULT: + self.emit_msg(self.new_start_line, + f"duplicate section name '{name}'\n") + # Treat as a new paragraph - add a blank line + self.sections[name] +=3D '\n' + contents + else: + self.sections[name] =3D contents + self.section_start_lines[name] =3D self.new_start_line + self.new_start_line =3D 0 + +# self.config.log.debug("Section: %s : %s", name, pformat(vars(self= ))) + + if start_new: + self.section =3D SECTION_DEFAULT + self._contents =3D [] + + +class KernelDoc: + """ + Read a C language source or header FILE and extract embedded + documentation comments. + """ + + # Section names + + section_context =3D "Context" + section_return =3D "Return" + + undescribed =3D "-- undescribed --" + + def __init__(self, config, fname): + """Initialize internal variables""" + + self.fname =3D fname + self.config =3D config + + # Initial state for the state machines + self.state =3D state.NORMAL + + # Store entry currently being processed + self.entry =3D None + + # Place all potential outputs into an array + self.entries =3D [] + + # + # We need Python 3.7 for its "dicts remember the insertion + # order" guarantee + # + if sys.version_info.major =3D=3D 3 and sys.version_info.minor < 7: + self.emit_msg(0, + 'Python 3.7 or later is required for correct res= ults') + + def emit_msg(self, ln, msg, warning=3DTrue): + """Emit a message""" + + log_msg =3D f"{self.fname}:{ln} {msg}" + + if self.entry: + self.entry.emit_msg(log_msg, warning) + return + + if warning: + self.config.log.warning(log_msg) + else: + self.config.log.info(log_msg) + + def dump_section(self, start_new=3DTrue): + """ + Dumps section contents to arrays/hashes intended for that purpose. + """ + + if self.entry: + self.entry.dump_section(start_new) + + # TODO: rename it to store_declaration after removal of kernel-doc.pl + def output_declaration(self, dtype, name, **args): + """ + Stores the entry into an entry array. + + The actual output and output filters will be handled elsewhere + """ + + item =3D KdocItem(name, dtype, self.entry.declaration_start_line, = **args) + item.warnings =3D self.entry.warnings + + # Drop empty sections + # TODO: improve empty sections logic to emit warnings + sections =3D self.entry.sections + for section in ["Description", "Return"]: + if section in sections and not sections[section].rstrip(): + del sections[section] + item.set_sections(sections, self.entry.section_start_lines) + item.set_params(self.entry.parameterlist, self.entry.parameterdesc= s, + self.entry.parametertypes, + self.entry.parameterdesc_start_lines) + self.entries.append(item) + + self.config.log.debug("Output: %s:%s =3D %s", dtype, name, pformat= (args)) + + def reset_state(self, ln): + """ + Ancillary routine to create a new entry. It initializes all + variables used by the state machine. + """ + + self.entry =3D KernelEntry(self.config, ln) + + # State flags + self.state =3D state.NORMAL + + def push_parameter(self, ln, decl_type, param, dtype, + org_arg, declaration_name): + """ + Store parameters and their descriptions at self.entry. + """ + + if self.entry.anon_struct_union and dtype =3D=3D "" and param =3D= =3D "}": + return # Ignore the ending }; from anonymous struct/union + + self.entry.anon_struct_union =3D False + + param =3D KernRe(r'[\[\)].*').sub('', param, count=3D1) + + if dtype =3D=3D "" and param.endswith("..."): + if KernRe(r'\w\.\.\.$').search(param): + # For named variable parameters of the form `x...`, + # remove the dots + param =3D param[:-3] + else: + # Handles unnamed variable parameters + param =3D "..." + + if param not in self.entry.parameterdescs or \ + not self.entry.parameterdescs[param]: + + self.entry.parameterdescs[param] =3D "variable arguments" + + elif dtype =3D=3D "" and (not param or param =3D=3D "void"): + param =3D "void" + self.entry.parameterdescs[param] =3D "no arguments" + + elif dtype =3D=3D "" and param in ["struct", "union"]: + # Handle unnamed (anonymous) union or struct + dtype =3D param + param =3D "{unnamed_" + param + "}" + self.entry.parameterdescs[param] =3D "anonymous\n" + self.entry.anon_struct_union =3D True + + # Handle cache group enforcing variables: they do not need + # to be described in header files + elif "__cacheline_group" in param: + # Ignore __cacheline_group_begin and __cacheline_group_end + return + + # Warn if parameter has no description + # (but ignore ones starting with # as these are not parameters + # but inline preprocessor statements) + if param not in self.entry.parameterdescs and not param.startswith= ("#"): + self.entry.parameterdescs[param] =3D self.undescribed + + if "." not in param: + if decl_type =3D=3D 'function': + dname =3D f"{decl_type} parameter" + else: + dname =3D f"{decl_type} member" + + self.emit_msg(ln, + f"{dname} '{param}' not described in '{decla= ration_name}'") + + # Strip spaces from param so that it is one continuous string on + # parameterlist. This fixes a problem where check_sections() + # cannot find a parameter like "addr[6 + 2]" because it actually + # appears as "addr[6", "+", "2]" on the parameter list. + # However, it's better to maintain the param string unchanged for + # output, so just weaken the string compare in check_sections() + # to ignore "[blah" in a parameter string. + + self.entry.parameterlist.append(param) + org_arg =3D KernRe(r'\s\s+').sub(' ', org_arg) + self.entry.parametertypes[param] =3D org_arg + + + def create_parameter_list(self, ln, decl_type, args, + splitter, declaration_name): + """ + Creates a list of parameters, storing them at self.entry. + """ + + # temporarily replace all commas inside function pointer definition + arg_expr =3D KernRe(r'(\([^\),]+),') + while arg_expr.search(args): + args =3D arg_expr.sub(r"\1#", args) + + for arg in args.split(splitter): + # Strip comments + arg =3D KernRe(r'\/\*.*\*\/').sub('', arg) + + # Ignore argument attributes + arg =3D KernRe(r'\sPOS0?\s').sub(' ', arg) + + # Strip leading/trailing spaces + arg =3D arg.strip() + arg =3D KernRe(r'\s+').sub(' ', arg, count=3D1) + + if arg.startswith('#'): + # Treat preprocessor directive as a typeless variable just= to fill + # corresponding data structures "correctly". Catch it late= r in + # output_* subs. + + # Treat preprocessor directive as a typeless variable + self.push_parameter(ln, decl_type, arg, "", + "", declaration_name) + + elif KernRe(r'\(.+\)\s*\(').search(arg): + # Pointer-to-function + + arg =3D arg.replace('#', ',') + + r =3D KernRe(r'[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)') + if r.match(arg): + param =3D r.group(1) + else: + self.emit_msg(ln, f"Invalid param: {arg}") + param =3D arg + + dtype =3D KernRe(r'([^\(]+\(\*?)\s*' + re.escape(param)).s= ub(r'\1', arg) + self.push_parameter(ln, decl_type, param, dtype, + arg, declaration_name) + + elif KernRe(r'\(.+\)\s*\[').search(arg): + # Array-of-pointers + + arg =3D arg.replace('#', ',') + r =3D KernRe(r'[^\(]+\(\s*\*\s*([\w\[\]\.]*?)\s*(\s*\[\s*[= \w]+\s*\]\s*)*\)') + if r.match(arg): + param =3D r.group(1) + else: + self.emit_msg(ln, f"Invalid param: {arg}") + param =3D arg + + dtype =3D KernRe(r'([^\(]+\(\*?)\s*' + re.escape(param)).s= ub(r'\1', arg) + + self.push_parameter(ln, decl_type, param, dtype, + arg, declaration_name) + + elif arg: + arg =3D KernRe(r'\s*:\s*').sub(":", arg) + arg =3D KernRe(r'\s*\[').sub('[', arg) + + args =3D KernRe(r'\s*,\s*').split(arg) + if args[0] and '*' in args[0]: + args[0] =3D re.sub(r'(\*+)\s*', r' \1', args[0]) + + first_arg =3D [] + r =3D KernRe(r'^(.*\s+)(.*?\[.*\].*)$') + if args[0] and r.match(args[0]): + args.pop(0) + first_arg.extend(r.group(1)) + first_arg.append(r.group(2)) + else: + first_arg =3D KernRe(r'\s+').split(args.pop(0)) + + args.insert(0, first_arg.pop()) + dtype =3D ' '.join(first_arg) + + for param in args: + if KernRe(r'^(\*+)\s*(.*)').match(param): + r =3D KernRe(r'^(\*+)\s*(.*)') + if not r.match(param): + self.emit_msg(ln, f"Invalid param: {param}") + continue + + param =3D r.group(1) + + self.push_parameter(ln, decl_type, r.group(2), + f"{dtype} {r.group(1)}", + arg, declaration_name) + + elif KernRe(r'(.*?):(\w+)').search(param): + r =3D KernRe(r'(.*?):(\w+)') + if not r.match(param): + self.emit_msg(ln, f"Invalid param: {param}") + continue + + if dtype !=3D "": # Skip unnamed bit-fields + self.push_parameter(ln, decl_type, r.group(1), + f"{dtype}:{r.group(2)}", + arg, declaration_name) + else: + self.push_parameter(ln, decl_type, param, dtype, + arg, declaration_name) + + def check_sections(self, ln, decl_name, decl_type): + """ + Check for errors inside sections, emitting warnings if not found + parameters are described. + """ + for section in self.entry.sections: + if section not in self.entry.parameterlist and \ + not known_sections.search(section): + if decl_type =3D=3D 'function': + dname =3D f"{decl_type} parameter" + else: + dname =3D f"{decl_type} member" + self.emit_msg(ln, + f"Excess {dname} '{section}' description in = '{decl_name}'") + + def check_return_section(self, ln, declaration_name, return_type): + """ + If the function doesn't return void, warns about the lack of a + return description. + """ + + if not self.config.wreturn: + return + + # Ignore an empty return type (It's a macro) + # Ignore functions with a "void" return type (but not "void *") + if not return_type or KernRe(r'void\s*\w*\s*$').search(return_type= ): + return + + if not self.entry.sections.get("Return", None): + self.emit_msg(ln, + f"No description found for return value of '{dec= laration_name}'") + + def dump_struct(self, ln, proto): + """ + Store an entry for an struct or union + """ + + type_pattern =3D r'(struct|union)' + + qualifiers =3D [ + "__attribute__", + "__packed", + "__aligned", + "____cacheline_aligned_in_smp", + "____cacheline_aligned", + ] + + definition_body =3D r'\{(.*)\}\s*' + "(?:" + '|'.join(qualifiers) = + ")?" + struct_members =3D KernRe(type_pattern + r'([^\{\};]+)(\{)([^\{\}]= *)(\})([^\{\}\;]*)(\;)') + + # Extract struct/union definition + members =3D None + declaration_name =3D None + decl_type =3D None + + r =3D KernRe(type_pattern + r'\s+(\w+)\s*' + definition_body) + if r.search(proto): + decl_type =3D r.group(1) + declaration_name =3D r.group(2) + members =3D r.group(3) + else: + r =3D KernRe(r'typedef\s+' + type_pattern + r'\s*' + definitio= n_body + r'\s*(\w+)\s*;') + + if r.search(proto): + decl_type =3D r.group(1) + declaration_name =3D r.group(3) + members =3D r.group(2) + + if not members: + self.emit_msg(ln, f"{proto} error: Cannot parse struct or unio= n!") + return + + if self.entry.identifier !=3D declaration_name: + self.emit_msg(ln, + f"expecting prototype for {decl_type} {self.entr= y.identifier}. Prototype was for {decl_type} {declaration_name} instead\n") + return + + args_pattern =3D r'([^,)]+)' + + sub_prefixes =3D [ + (KernRe(r'\/\*\s*private:.*?\/\*\s*public:.*?\*\/', re.S | re.= I), ''), + (KernRe(r'\/\*\s*private:.*', re.S | re.I), ''), + + # Strip comments + (KernRe(r'\/\*.*?\*\/', re.S), ''), + + # Strip attributes + (attribute, ' '), + (KernRe(r'\s*__aligned\s*\([^;]*\)', re.S), ' '), + (KernRe(r'\s*__counted_by\s*\([^;]*\)', re.S), ' '), + (KernRe(r'\s*__counted_by_(le|be)\s*\([^;]*\)', re.S), ' '), + (KernRe(r'\s*__packed\s*', re.S), ' '), + (KernRe(r'\s*CRYPTO_MINALIGN_ATTR', re.S), ' '), + (KernRe(r'\s*____cacheline_aligned_in_smp', re.S), ' '), + (KernRe(r'\s*____cacheline_aligned', re.S), ' '), + + # Unwrap struct_group macros based on this definition: + # __struct_group(TAG, NAME, ATTRS, MEMBERS...) + # which has variants like: struct_group(NAME, MEMBERS...) + # Only MEMBERS arguments require documentation. + # + # Parsing them happens on two steps: + # + # 1. drop struct group arguments that aren't at MEMBERS, + # storing them as STRUCT_GROUP(MEMBERS) + # + # 2. remove STRUCT_GROUP() ancillary macro. + # + # The original logic used to remove STRUCT_GROUP() using an + # advanced regex: + # + # \bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*; + # + # with two patterns that are incompatible with + # Python re module, as it has: + # + # - a recursive pattern: (?1) + # - an atomic grouping: (?>...) + # + # I tried a simpler version: but it didn't work either: + # \bSTRUCT_GROUP\(([^\)]+)\)[^;]*; + # + # As it doesn't properly match the end parenthesis on some cas= es. + # + # So, a better solution was crafted: there's now a NestedMatch + # class that ensures that delimiters after a search are proper= ly + # matched. So, the implementation to drop STRUCT_GROUP() will = be + # handled in separate. + + (KernRe(r'\bstruct_group\s*\(([^,]*,)', re.S), r'STRUCT_GROUP(= '), + (KernRe(r'\bstruct_group_attr\s*\(([^,]*,){2}', re.S), r'STRUC= T_GROUP('), + (KernRe(r'\bstruct_group_tagged\s*\(([^,]*),([^,]*),', re.S), = r'struct \1 \2; STRUCT_GROUP('), + (KernRe(r'\b__struct_group\s*\(([^,]*,){3}', re.S), r'STRUCT_G= ROUP('), + + # Replace macros + # + # TODO: use NestedMatch for FOO($1, $2, ...) matches + # + # it is better to also move those to the NestedMatch logic, + # to ensure that parenthesis will be properly matched. + + (KernRe(r'__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)', re= .S), r'DECLARE_BITMAP(\1, __ETHTOOL_LINK_MODE_MASK_NBITS)'), + (KernRe(r'DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)', re.S), r= 'DECLARE_BITMAP(\1, PHY_INTERFACE_MODE_MAX)'), + (KernRe(r'DECLARE_BITMAP\s*\(' + args_pattern + r',\s*' + args= _pattern + r'\)', re.S), r'unsigned long \1[BITS_TO_LONGS(\2)]'), + (KernRe(r'DECLARE_HASHTABLE\s*\(' + args_pattern + r',\s*' + a= rgs_pattern + r'\)', re.S), r'unsigned long \1[1 << ((\2) - 1)]'), + (KernRe(r'DECLARE_KFIFO\s*\(' + args_pattern + r',\s*' + args_= pattern + r',\s*' + args_pattern + r'\)', re.S), r'\2 *\1'), + (KernRe(r'DECLARE_KFIFO_PTR\s*\(' + args_pattern + r',\s*' + a= rgs_pattern + r'\)', re.S), r'\2 *\1'), + (KernRe(r'(?:__)?DECLARE_FLEX_ARRAY\s*\(' + args_pattern + r',= \s*' + args_pattern + r'\)', re.S), r'\1 \2[]'), + (KernRe(r'DEFINE_DMA_UNMAP_ADDR\s*\(' + args_pattern + r'\)', = re.S), r'dma_addr_t \1'), + (KernRe(r'DEFINE_DMA_UNMAP_LEN\s*\(' + args_pattern + r'\)', r= e.S), r'__u32 \1'), + (KernRe(r'VIRTIO_DECLARE_FEATURES\s*\(' + args_pattern + r'\)'= , re.S), r'u64 \1; u64 \1_array[VIRTIO_FEATURES_DWORDS]'), + ] + + # Regexes here are guaranteed to have the end limiter matching + # the start delimiter. Yet, right now, only one replace group + # is allowed. + + sub_nested_prefixes =3D [ + (re.compile(r'\bSTRUCT_GROUP\('), r'\1'), + ] + + for search, sub in sub_prefixes: + members =3D search.sub(sub, members) + + nested =3D NestedMatch() + + for search, sub in sub_nested_prefixes: + members =3D nested.sub(search, sub, members) + + # Keeps the original declaration as-is + declaration =3D members + + # Split nested struct/union elements + # + # This loop was simpler at the original kernel-doc perl version, as + # while ($members =3D~ m/$struct_members/) { ... } + # reads 'members' string on each interaction. + # + # Python behavior is different: it parses 'members' only once, + # creating a list of tuples from the first interaction. + # + # On other words, this won't get nested structs. + # + # So, we need to have an extra loop on Python to override such + # re limitation. + + while True: + tuples =3D struct_members.findall(members) + if not tuples: + break + + for t in tuples: + newmember =3D "" + maintype =3D t[0] + s_ids =3D t[5] + content =3D t[3] + + oldmember =3D "".join(t) + + for s_id in s_ids.split(','): + s_id =3D s_id.strip() + + newmember +=3D f"{maintype} {s_id}; " + s_id =3D KernRe(r'[:\[].*').sub('', s_id) + s_id =3D KernRe(r'^\s*\**(\S+)\s*').sub(r'\1', s_id) + + for arg in content.split(';'): + arg =3D arg.strip() + + if not arg: + continue + + r =3D KernRe(r'^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)= ') + if r.match(arg): + # Pointer-to-function + dtype =3D r.group(1) + name =3D r.group(2) + extra =3D r.group(3) + + if not name: + continue + + if not s_id: + # Anonymous struct/union + newmember +=3D f"{dtype}{name}{extra}; " + else: + newmember +=3D f"{dtype}{s_id}.{name}{extr= a}; " + + else: + arg =3D arg.strip() + # Handle bitmaps + arg =3D KernRe(r':\s*\d+\s*').sub('', arg) + + # Handle arrays + arg =3D KernRe(r'\[.*\]').sub('', arg) + + # Handle multiple IDs + arg =3D KernRe(r'\s*,\s*').sub(',', arg) + + r =3D KernRe(r'(.*)\s+([\S+,]+)') + + if r.search(arg): + dtype =3D r.group(1) + names =3D r.group(2) + else: + newmember +=3D f"{arg}; " + continue + + for name in names.split(','): + name =3D KernRe(r'^\s*\**(\S+)\s*').sub(r'= \1', name).strip() + + if not name: + continue + + if not s_id: + # Anonymous struct/union + newmember +=3D f"{dtype} {name}; " + else: + newmember +=3D f"{dtype} {s_id}.{name}= ; " + + members =3D members.replace(oldmember, newmember) + + # Ignore other nested elements, like enums + members =3D re.sub(r'(\{[^\{\}]*\})', '', members) + + self.create_parameter_list(ln, decl_type, members, ';', + declaration_name) + self.check_sections(ln, declaration_name, decl_type) + + # Adjust declaration for better display + declaration =3D KernRe(r'([\{;])').sub(r'\1\n', declaration) + declaration =3D KernRe(r'\}\s+;').sub('};', declaration) + + # Better handle inlined enums + while True: + r =3D KernRe(r'(enum\s+\{[^\}]+),([^\n])') + if not r.search(declaration): + break + + declaration =3D r.sub(r'\1,\n\2', declaration) + + def_args =3D declaration.split('\n') + level =3D 1 + declaration =3D "" + for clause in def_args: + + clause =3D clause.strip() + clause =3D KernRe(r'\s+').sub(' ', clause, count=3D1) + + if not clause: + continue + + if '}' in clause and level > 1: + level -=3D 1 + + if not KernRe(r'^\s*#').match(clause): + declaration +=3D "\t" * level + + declaration +=3D "\t" + clause + "\n" + if "{" in clause and "}" not in clause: + level +=3D 1 + + self.output_declaration(decl_type, declaration_name, + definition=3Ddeclaration, + purpose=3Dself.entry.declaration_purpose) + + def dump_enum(self, ln, proto): + """ + Stores an enum inside self.entries array. + """ + + # Ignore members marked private + proto =3D KernRe(r'\/\*\s*private:.*?\/\*\s*public:.*?\*\/', flags= =3Dre.S).sub('', proto) + proto =3D KernRe(r'\/\*\s*private:.*}', flags=3Dre.S).sub('}', pro= to) + + # Strip comments + proto =3D KernRe(r'\/\*.*?\*\/', flags=3Dre.S).sub('', proto) + + # Strip #define macros inside enums + proto =3D KernRe(r'#\s*((define|ifdef|if)\s+|endif)[^;]*;', flags= =3Dre.S).sub('', proto) + + # + # Parse out the name and members of the enum. Typedef form first. + # + r =3D KernRe(r'typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;') + if r.search(proto): + declaration_name =3D r.group(2) + members =3D r.group(1).rstrip() + # + # Failing that, look for a straight enum + # + else: + r =3D KernRe(r'enum\s+(\w*)\s*\{(.*)\}') + if r.match(proto): + declaration_name =3D r.group(1) + members =3D r.group(2).rstrip() + # + # OK, this isn't going to work. + # + else: + self.emit_msg(ln, f"{proto}: error: Cannot parse enum!") + return + # + # Make sure we found what we were expecting. + # + if self.entry.identifier !=3D declaration_name: + if self.entry.identifier =3D=3D "": + self.emit_msg(ln, + f"{proto}: wrong kernel-doc identifier on pr= ototype") + else: + self.emit_msg(ln, + f"expecting prototype for enum {self.entry.i= dentifier}. " + f"Prototype was for enum {declaration_name} = instead") + return + + if not declaration_name: + declaration_name =3D "(anonymous)" + # + # Parse out the name of each enum member, and verify that we + # have a description for it. + # + member_set =3D set() + members =3D KernRe(r'\([^;)]*\)').sub('', members) + for arg in members.split(','): + if not arg: + continue + arg =3D KernRe(r'^\s*(\w+).*').sub(r'\1', arg) + self.entry.parameterlist.append(arg) + if arg not in self.entry.parameterdescs: + self.entry.parameterdescs[arg] =3D self.undescribed + self.emit_msg(ln, + f"Enum value '{arg}' not described in enum '= {declaration_name}'") + member_set.add(arg) + # + # Ensure that every described member actually exists in the enum. + # + for k in self.entry.parameterdescs: + if k not in member_set: + self.emit_msg(ln, + f"Excess enum value '%{k}' description in '{= declaration_name}'") + + self.output_declaration('enum', declaration_name, + purpose=3Dself.entry.declaration_purpose) + + def dump_declaration(self, ln, prototype): + """ + Stores a data declaration inside self.entries array. + """ + + if self.entry.decl_type =3D=3D "enum": + self.dump_enum(ln, prototype) + elif self.entry.decl_type =3D=3D "typedef": + self.dump_typedef(ln, prototype) + elif self.entry.decl_type in ["union", "struct"]: + self.dump_struct(ln, prototype) + else: + # This would be a bug + self.emit_message(ln, f'Unknown declaration type: {self.entry.= decl_type}') + + def dump_function(self, ln, prototype): + """ + Stores a function of function macro inside self.entries array. + """ + + func_macro =3D False + return_type =3D '' + decl_type =3D 'function' + + # Prefixes that would be removed + sub_prefixes =3D [ + (r"^static +", "", 0), + (r"^extern +", "", 0), + (r"^asmlinkage +", "", 0), + (r"^inline +", "", 0), + (r"^__inline__ +", "", 0), + (r"^__inline +", "", 0), + (r"^__always_inline +", "", 0), + (r"^noinline +", "", 0), + (r"^__FORTIFY_INLINE +", "", 0), + (r"__init +", "", 0), + (r"__init_or_module +", "", 0), + (r"__deprecated +", "", 0), + (r"__flatten +", "", 0), + (r"__meminit +", "", 0), + (r"__must_check +", "", 0), + (r"__weak +", "", 0), + (r"__sched +", "", 0), + (r"_noprof", "", 0), + (r"__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +", "", 0), + (r"__(?:re)?alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +", "", = 0), + (r"__diagnose_as\s*\(\s*\S+\s*(?:,\s*\d+\s*)*\) +", "", 0), + (r"DECL_BUCKET_PARAMS\s*\(\s*(\S+)\s*,\s*(\S+)\s*\)", r"\1, \2= ", 0), + (r"__attribute_const__ +", "", 0), + + # It seems that Python support for re.X is broken: + # At least for me (Python 3.13), this didn't work +# (r""" +# __attribute__\s*\(\( +# (?: +# [\w\s]+ # attribute name +# (?:\([^)]*\))? # attribute arguments +# \s*,? # optional comma at the end +# )+ +# \)\)\s+ +# """, "", re.X), + + # So, remove whitespaces and comments from it + (r"__attribute__\s*\(\((?:[\w\s]+(?:\([^)]*\))?\s*,?)+\)\)\s+"= , "", 0), + ] + + for search, sub, flags in sub_prefixes: + prototype =3D KernRe(search, flags).sub(sub, prototype) + + # Macros are a special case, as they change the prototype format + new_proto =3D KernRe(r"^#\s*define\s+").sub("", prototype) + if new_proto !=3D prototype: + is_define_proto =3D True + prototype =3D new_proto + else: + is_define_proto =3D False + + # Yes, this truly is vile. We are looking for: + # 1. Return type (may be nothing if we're looking at a macro) + # 2. Function name + # 3. Function parameters. + # + # All the while we have to watch out for function pointer paramete= rs + # (which IIRC is what the two sections are for), C types (these + # regexps don't even start to express all the possibilities), and + # so on. + # + # If you mess with these regexps, it's a good idea to check that + # the following functions' documentation still comes out right: + # - parport_register_device (function pointer parameters) + # - atomic_set (macro) + # - pci_match_device, __copy_to_user (long return type) + + name =3D r'[a-zA-Z0-9_~:]+' + prototype_end1 =3D r'[^\(]*' + prototype_end2 =3D r'[^\{]*' + prototype_end =3D fr'\(({prototype_end1}|{prototype_end2})\)' + + # Besides compiling, Perl qr{[\w\s]+} works as a non-capturing gro= up. + # So, this needs to be mapped in Python with (?:...)? or (?:...)+ + + type1 =3D r'(?:[\w\s]+)?' + type2 =3D r'(?:[\w\s]+\*+)+' + + found =3D False + + if is_define_proto: + r =3D KernRe(r'^()(' + name + r')\s+') + + if r.search(prototype): + return_type =3D '' + declaration_name =3D r.group(2) + func_macro =3D True + + found =3D True + + if not found: + patterns =3D [ + rf'^()({name})\s*{prototype_end}', + rf'^({type1})\s+({name})\s*{prototype_end}', + rf'^({type2})\s*({name})\s*{prototype_end}', + ] + + for p in patterns: + r =3D KernRe(p) + + if r.match(prototype): + + return_type =3D r.group(1) + declaration_name =3D r.group(2) + args =3D r.group(3) + + self.create_parameter_list(ln, decl_type, args, ',', + declaration_name) + + found =3D True + break + if not found: + self.emit_msg(ln, + f"cannot understand function prototype: '{protot= ype}'") + return + + if self.entry.identifier !=3D declaration_name: + self.emit_msg(ln, + f"expecting prototype for {self.entry.identifier= }(). Prototype was for {declaration_name}() instead") + return + + self.check_sections(ln, declaration_name, "function") + + self.check_return_section(ln, declaration_name, return_type) + + if 'typedef' in return_type: + self.output_declaration(decl_type, declaration_name, + typedef=3DTrue, + functiontype=3Dreturn_type, + purpose=3Dself.entry.declaration_purpo= se, + func_macro=3Dfunc_macro) + else: + self.output_declaration(decl_type, declaration_name, + typedef=3DFalse, + functiontype=3Dreturn_type, + purpose=3Dself.entry.declaration_purpo= se, + func_macro=3Dfunc_macro) + + def dump_typedef(self, ln, proto): + """ + Stores a typedef inside self.entries array. + """ + + typedef_type =3D r'((?:\s+[\w\*]+\b){0,7}\s+(?:\w+\b|\*+))\s*' + typedef_ident =3D r'\*?\s*(\w\S+)\s*' + typedef_args =3D r'\s*\((.*)\);' + + typedef1 =3D KernRe(r'typedef' + typedef_type + r'\(' + typedef_id= ent + r'\)' + typedef_args) + typedef2 =3D KernRe(r'typedef' + typedef_type + typedef_ident + ty= pedef_args) + + # Strip comments + proto =3D KernRe(r'/\*.*?\*/', flags=3Dre.S).sub('', proto) + + # Parse function typedef prototypes + for r in [typedef1, typedef2]: + if not r.match(proto): + continue + + return_type =3D r.group(1).strip() + declaration_name =3D r.group(2) + args =3D r.group(3) + + if self.entry.identifier !=3D declaration_name: + self.emit_msg(ln, + f"expecting prototype for typedef {self.entr= y.identifier}. Prototype was for typedef {declaration_name} instead\n") + return + + decl_type =3D 'function' + self.create_parameter_list(ln, decl_type, args, ',', declarati= on_name) + + self.output_declaration(decl_type, declaration_name, + typedef=3DTrue, + functiontype=3Dreturn_type, + purpose=3Dself.entry.declaration_purpo= se) + return + + # Handle nested parentheses or brackets + r =3D KernRe(r'(\(*.\)\s*|\[*.\]\s*);$') + while r.search(proto): + proto =3D r.sub('', proto) + + # Parse simple typedefs + r =3D KernRe(r'typedef.*\s+(\w+)\s*;') + if r.match(proto): + declaration_name =3D r.group(1) + + if self.entry.identifier !=3D declaration_name: + self.emit_msg(ln, + f"expecting prototype for typedef {self.entr= y.identifier}. Prototype was for typedef {declaration_name} instead\n") + return + + self.output_declaration('typedef', declaration_name, + purpose=3Dself.entry.declaration_purpo= se) + return + + self.emit_msg(ln, "error: Cannot parse typedef!") + + @staticmethod + def process_export(function_set, line): + """ + process EXPORT_SYMBOL* tags + + This method doesn't use any variable from the class, so declare it + with a staticmethod decorator. + """ + + # We support documenting some exported symbols with different + # names. A horrible hack. + suffixes =3D [ '_noprof' ] + + # Note: it accepts only one EXPORT_SYMBOL* per line, as having + # multiple export lines would violate Kernel coding style. + + if export_symbol.search(line): + symbol =3D export_symbol.group(2) + elif export_symbol_ns.search(line): + symbol =3D export_symbol_ns.group(2) + else: + return False + # + # Found an export, trim out any special suffixes + # + for suffix in suffixes: + # Be backward compatible with Python < 3.9 + if symbol.endswith(suffix): + symbol =3D symbol[:-len(suffix)] + function_set.add(symbol) + return True + + def process_normal(self, ln, line): + """ + STATE_NORMAL: looking for the /** to begin everything. + """ + + if not doc_start.match(line): + return + + # start a new entry + self.reset_state(ln) + + # next line is always the function name + self.state =3D state.NAME + + def process_name(self, ln, line): + """ + STATE_NAME: Looking for the "name - description" line + """ + # + # Check for a DOC: block and handle them specially. + # + if doc_block.search(line): + + if not doc_block.group(1): + self.entry.begin_section(ln, "Introduction") + else: + self.entry.begin_section(ln, doc_block.group(1)) + + self.entry.identifier =3D self.entry.section + self.state =3D state.DOCBLOCK + # + # Otherwise we're looking for a normal kerneldoc declaration line. + # + elif doc_decl.search(line): + self.entry.identifier =3D doc_decl.group(1) + + # Test for data declaration + if doc_begin_data.search(line): + self.entry.decl_type =3D doc_begin_data.group(1) + self.entry.identifier =3D doc_begin_data.group(2) + # + # Look for a function description + # + elif doc_begin_func.search(line): + self.entry.identifier =3D doc_begin_func.group(1) + self.entry.decl_type =3D "function" + # + # We struck out. + # + else: + self.emit_msg(ln, + f"This comment starts with '/**', but isn't = a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n{line}") + self.state =3D state.NORMAL + return + # + # OK, set up for a new kerneldoc entry. + # + self.state =3D state.BODY + self.entry.identifier =3D self.entry.identifier.strip(" ") + # if there's no @param blocks need to set up default section h= ere + self.entry.begin_section(ln + 1) + # + # Find the description portion, which *should* be there but + # isn't always. + # (We should be able to capture this from the previous parsing= - someday) + # + r =3D KernRe("[-:](.*)") + if r.search(line): + self.entry.declaration_purpose =3D trim_whitespace(r.group= (1)) + self.state =3D state.DECLARATION + else: + self.entry.declaration_purpose =3D "" + + if not self.entry.declaration_purpose and self.config.wshort_d= esc: + self.emit_msg(ln, + f"missing initial short description on line:= \n{line}") + + if not self.entry.identifier and self.entry.decl_type !=3D "en= um": + self.emit_msg(ln, + f"wrong kernel-doc identifier on line:\n{lin= e}") + self.state =3D state.NORMAL + + if self.config.verbose: + self.emit_msg(ln, + f"Scanning doc for {self.entry.decl_type} {s= elf.entry.identifier}", + warning=3DFalse) + # + # Failed to find an identifier. Emit a warning + # + else: + self.emit_msg(ln, f"Cannot find identifier on line:\n{line}") + + # + # Helper function to determine if a new section is being started. + # + def is_new_section(self, ln, line): + if doc_sect.search(line): + self.state =3D state.BODY + # + # Pick out the name of our new section, tweaking it if need be. + # + newsection =3D doc_sect.group(1) + if newsection.lower() =3D=3D 'description': + newsection =3D 'Description' + elif newsection.lower() =3D=3D 'context': + newsection =3D 'Context' + self.state =3D state.SPECIAL_SECTION + elif newsection.lower() in ["@return", "@returns", + "return", "returns"]: + newsection =3D "Return" + self.state =3D state.SPECIAL_SECTION + elif newsection[0] =3D=3D '@': + self.state =3D state.SPECIAL_SECTION + # + # Initialize the contents, and get the new section going. + # + newcontents =3D doc_sect.group(2) + if not newcontents: + newcontents =3D "" + self.dump_section() + self.entry.begin_section(ln, newsection) + self.entry.leading_space =3D None + + self.entry.add_text(newcontents.lstrip()) + return True + return False + + # + # Helper function to detect (and effect) the end of a kerneldoc commen= t. + # + def is_comment_end(self, ln, line): + if doc_end.search(line): + self.dump_section() + + # Look for doc_com + + doc_end: + r =3D KernRe(r'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') + if r.match(line): + self.emit_msg(ln, f"suspicious ending line: {line}") + + self.entry.prototype =3D "" + self.entry.new_start_line =3D ln + 1 + + self.state =3D state.PROTO + return True + return False + + + def process_decl(self, ln, line): + """ + STATE_DECLARATION: We've seen the beginning of a declaration + """ + if self.is_new_section(ln, line) or self.is_comment_end(ln, line): + return + # + # Look for anything with the " * " line beginning. + # + if doc_content.search(line): + cont =3D doc_content.group(1) + # + # A blank line means that we have moved out of the declaration + # part of the comment (without any "special section" parameter + # descriptions). + # + if cont =3D=3D "": + self.state =3D state.BODY + # + # Otherwise we have more of the declaration section to soak up. + # + else: + self.entry.declaration_purpose =3D \ + trim_whitespace(self.entry.declaration_purpose + ' ' += cont) + else: + # Unknown line, ignore + self.emit_msg(ln, f"bad line: {line}") + + + def process_special(self, ln, line): + """ + STATE_SPECIAL_SECTION: a section ending with a blank line + """ + # + # If we have hit a blank line (only the " * " marker), then this + # section is done. + # + if KernRe(r"\s*\*\s*$").match(line): + self.entry.begin_section(ln, dump =3D True) + self.state =3D state.BODY + return + # + # Not a blank line, look for the other ways to end the section. + # + if self.is_new_section(ln, line) or self.is_comment_end(ln, line): + return + # + # OK, we should have a continuation of the text for this section. + # + if doc_content.search(line): + cont =3D doc_content.group(1) + # + # If the lines of text after the first in a special section ha= ve + # leading white space, we need to trim it out or Sphinx will g= et + # confused. For the second line (the None case), see what we + # find there and remember it. + # + if self.entry.leading_space is None: + r =3D KernRe(r'^(\s+)') + if r.match(cont): + self.entry.leading_space =3D len(r.group(1)) + else: + self.entry.leading_space =3D 0 + # + # Otherwise, before trimming any leading chars, be *sure* + # that they are white space. We should maybe warn if this + # isn't the case. + # + for i in range(0, self.entry.leading_space): + if cont[i] !=3D " ": + self.entry.leading_space =3D i + break + # + # Add the trimmed result to the section and we're done. + # + self.entry.add_text(cont[self.entry.leading_space:]) + else: + # Unknown line, ignore + self.emit_msg(ln, f"bad line: {line}") + + def process_body(self, ln, line): + """ + STATE_BODY: the bulk of a kerneldoc comment. + """ + if self.is_new_section(ln, line) or self.is_comment_end(ln, line): + return + + if doc_content.search(line): + cont =3D doc_content.group(1) + self.entry.add_text(cont) + else: + # Unknown line, ignore + self.emit_msg(ln, f"bad line: {line}") + + def process_inline_name(self, ln, line): + """STATE_INLINE_NAME: beginning of docbook comments within a proto= type.""" + + if doc_inline_sect.search(line): + self.entry.begin_section(ln, doc_inline_sect.group(1)) + self.entry.add_text(doc_inline_sect.group(2).lstrip()) + self.state =3D state.INLINE_TEXT + elif doc_inline_end.search(line): + self.dump_section() + self.state =3D state.PROTO + elif doc_content.search(line): + self.emit_msg(ln, f"Incorrect use of kernel-doc format: {line}= ") + self.state =3D state.PROTO + # else ... ?? + + def process_inline_text(self, ln, line): + """STATE_INLINE_TEXT: docbook comments within a prototype.""" + + if doc_inline_end.search(line): + self.dump_section() + self.state =3D state.PROTO + elif doc_content.search(line): + self.entry.add_text(doc_content.group(1)) + # else ... ?? + + def syscall_munge(self, ln, proto): # pylint: disable=3DW0613 + """ + Handle syscall definitions + """ + + is_void =3D False + + # Strip newlines/CR's + proto =3D re.sub(r'[\r\n]+', ' ', proto) + + # Check if it's a SYSCALL_DEFINE0 + if 'SYSCALL_DEFINE0' in proto: + is_void =3D True + + # Replace SYSCALL_DEFINE with correct return type & function name + proto =3D KernRe(r'SYSCALL_DEFINE.*\(').sub('long sys_', proto) + + r =3D KernRe(r'long\s+(sys_.*?),') + if r.search(proto): + proto =3D KernRe(',').sub('(', proto, count=3D1) + elif is_void: + proto =3D KernRe(r'\)').sub('(void)', proto, count=3D1) + + # Now delete all of the odd-numbered commas in the proto + # so that argument types & names don't have a comma between them + count =3D 0 + length =3D len(proto) + + if is_void: + length =3D 0 # skip the loop if is_void + + for ix in range(length): + if proto[ix] =3D=3D ',': + count +=3D 1 + if count % 2 =3D=3D 1: + proto =3D proto[:ix] + ' ' + proto[ix + 1:] + + return proto + + def tracepoint_munge(self, ln, proto): + """ + Handle tracepoint definitions + """ + + tracepointname =3D None + tracepointargs =3D None + + # Match tracepoint name based on different patterns + r =3D KernRe(r'TRACE_EVENT\((.*?),') + if r.search(proto): + tracepointname =3D r.group(1) + + r =3D KernRe(r'DEFINE_SINGLE_EVENT\((.*?),') + if r.search(proto): + tracepointname =3D r.group(1) + + r =3D KernRe(r'DEFINE_EVENT\((.*?),(.*?),') + if r.search(proto): + tracepointname =3D r.group(2) + + if tracepointname: + tracepointname =3D tracepointname.lstrip() + + r =3D KernRe(r'TP_PROTO\((.*?)\)') + if r.search(proto): + tracepointargs =3D r.group(1) + + if not tracepointname or not tracepointargs: + self.emit_msg(ln, + f"Unrecognized tracepoint format:\n{proto}\n") + else: + proto =3D f"static inline void trace_{tracepointname}({tracepo= intargs})" + self.entry.identifier =3D f"trace_{self.entry.identifier}" + + return proto + + def process_proto_function(self, ln, line): + """Ancillary routine to process a function prototype""" + + # strip C99-style comments to end of line + line =3D KernRe(r"\/\/.*$", re.S).sub('', line) + # + # Soak up the line's worth of prototype text, stopping at { or ; i= f present. + # + if KernRe(r'\s*#\s*define').match(line): + self.entry.prototype =3D line + elif not line.startswith('#'): # skip other preprocessor stuff + r =3D KernRe(r'([^\{]*)') + if r.match(line): + self.entry.prototype +=3D r.group(1) + " " + # + # If we now have the whole prototype, clean it up and declare vict= ory. + # + if '{' in line or ';' in line or KernRe(r'\s*#\s*define').match(li= ne): + # strip comments and surrounding spaces + self.entry.prototype =3D KernRe(r'/\*.*\*/').sub('', self.entr= y.prototype).strip() + # + # Handle self.entry.prototypes for function pointers like: + # int (*pcs_config)(struct foo) + # by turning it into + # int pcs_config(struct foo) + # + r =3D KernRe(r'^(\S+\s+)\(\s*\*(\S+)\)') + self.entry.prototype =3D r.sub(r'\1\2', self.entry.prototype) + # + # Handle special declaration syntaxes + # + if 'SYSCALL_DEFINE' in self.entry.prototype: + self.entry.prototype =3D self.syscall_munge(ln, + self.entry.proto= type) + else: + r =3D KernRe(r'TRACE_EVENT|DEFINE_EVENT|DEFINE_SINGLE_EVEN= T') + if r.search(self.entry.prototype): + self.entry.prototype =3D self.tracepoint_munge(ln, + self.entr= y.prototype) + # + # ... and we're done + # + self.dump_function(ln, self.entry.prototype) + self.reset_state(ln) + + def process_proto_type(self, ln, line): + """Ancillary routine to process a type""" + + # Strip C99-style comments and surrounding whitespace + line =3D KernRe(r"//.*$", re.S).sub('', line).strip() + if not line: + return # nothing to see here + + # To distinguish preprocessor directive from regular declaration l= ater. + if line.startswith('#'): + line +=3D ";" + # + # Split the declaration on any of { } or ;, and accumulate pieces + # until we hit a semicolon while not inside {brackets} + # + r =3D KernRe(r'(.*?)([{};])') + for chunk in r.split(line): + if chunk: # Ignore empty matches + self.entry.prototype +=3D chunk + # + # This cries out for a match statement ... someday after w= e can + # drop Python 3.9 ... + # + if chunk =3D=3D '{': + self.entry.brcount +=3D 1 + elif chunk =3D=3D '}': + self.entry.brcount -=3D 1 + elif chunk =3D=3D ';' and self.entry.brcount <=3D 0: + self.dump_declaration(ln, self.entry.prototype) + self.reset_state(ln) + return + # + # We hit the end of the line while still in the declaration; put + # in a space to represent the newline. + # + self.entry.prototype +=3D ' ' + + def process_proto(self, ln, line): + """STATE_PROTO: reading a function/whatever prototype.""" + + if doc_inline_oneline.search(line): + self.entry.begin_section(ln, doc_inline_oneline.group(1)) + self.entry.add_text(doc_inline_oneline.group(2)) + self.dump_section() + + elif doc_inline_start.search(line): + self.state =3D state.INLINE_NAME + + elif self.entry.decl_type =3D=3D 'function': + self.process_proto_function(ln, line) + + else: + self.process_proto_type(ln, line) + + def process_docblock(self, ln, line): + """STATE_DOCBLOCK: within a DOC: block.""" + + if doc_end.search(line): + self.dump_section() + self.output_declaration("doc", self.entry.identifier) + self.reset_state(ln) + + elif doc_content.search(line): + self.entry.add_text(doc_content.group(1)) + + def parse_export(self): + """ + Parses EXPORT_SYMBOL* macros from a single Kernel source file. + """ + + export_table =3D set() + + try: + with open(self.fname, "r", encoding=3D"utf8", + errors=3D"backslashreplace") as fp: + + for line in fp: + self.process_export(export_table, line) + + except IOError: + return None + + return export_table + + # + # The state/action table telling us which function to invoke in + # each state. + # + state_actions =3D { + state.NORMAL: process_normal, + state.NAME: process_name, + state.BODY: process_body, + state.DECLARATION: process_decl, + state.SPECIAL_SECTION: process_special, + state.INLINE_NAME: process_inline_name, + state.INLINE_TEXT: process_inline_text, + state.PROTO: process_proto, + state.DOCBLOCK: process_docblock, + } + + def parse_kdoc(self): + """ + Open and process each line of a C source file. + The parsing is controlled via a state machine, and the line is pas= sed + to a different process function depending on the state. The process + function may update the state as needed. + + Besides parsing kernel-doc tags, it also parses export symbols. + """ + + prev =3D "" + prev_ln =3D None + export_table =3D set() + + try: + with open(self.fname, "r", encoding=3D"utf8", + errors=3D"backslashreplace") as fp: + for ln, line in enumerate(fp): + + line =3D line.expandtabs().strip("\n") + + # Group continuation lines on prototypes + if self.state =3D=3D state.PROTO: + if line.endswith("\\"): + prev +=3D line.rstrip("\\") + if not prev_ln: + prev_ln =3D ln + continue + + if prev: + ln =3D prev_ln + line =3D prev + line + prev =3D "" + prev_ln =3D None + + self.config.log.debug("%d %s: %s", + ln, state.name[self.state], + line) + + # This is an optimization over the original script. + # There, when export_file was used for the same file, + # it was read twice. Here, we use the already-existing + # loop to parse exported symbols as well. + # + if (self.state !=3D state.NORMAL) or \ + not self.process_export(export_table, line): + # Hand this line to the appropriate state handler + self.state_actions[self.state](self, ln, line) + + except OSError: + self.config.log.error(f"Error: Cannot open file {self.fname}") + + return export_table, self.entries diff --git a/scripts/lib/kdoc/kdoc_re.py b/scripts/lib/kdoc/kdoc_re.py new file mode 100644 index 00000000000..612223e1e72 --- /dev/null +++ b/scripts/lib/kdoc/kdoc_re.py @@ -0,0 +1,270 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0 +# Copyright(c) 2025: Mauro Carvalho Chehab . + +""" +Regular expression ancillary classes. + +Those help caching regular expressions and do matching for kernel-doc. +""" + +import re + +# Local cache for regular expressions +re_cache =3D {} + + +class KernRe: + """ + Helper class to simplify regex declaration and usage, + + It calls re.compile for a given pattern. It also allows adding + regular expressions and define sub at class init time. + + Regular expressions can be cached via an argument, helping to speedup + searches. + """ + + def _add_regex(self, string, flags): + """ + Adds a new regex or re-use it from the cache. + """ + self.regex =3D re_cache.get(string, None) + if not self.regex: + self.regex =3D re.compile(string, flags=3Dflags) + if self.cache: + re_cache[string] =3D self.regex + + def __init__(self, string, cache=3DTrue, flags=3D0): + """ + Compile a regular expression and initialize internal vars. + """ + + self.cache =3D cache + self.last_match =3D None + + self._add_regex(string, flags) + + def __str__(self): + """ + Return the regular expression pattern. + """ + return self.regex.pattern + + def __add__(self, other): + """ + Allows adding two regular expressions into one. + """ + + return KernRe(str(self) + str(other), cache=3Dself.cache or other.= cache, + flags=3Dself.regex.flags | other.regex.flags) + + def match(self, string): + """ + Handles a re.match storing its results + """ + + self.last_match =3D self.regex.match(string) + return self.last_match + + def search(self, string): + """ + Handles a re.search storing its results + """ + + self.last_match =3D self.regex.search(string) + return self.last_match + + def findall(self, string): + """ + Alias to re.findall + """ + + return self.regex.findall(string) + + def split(self, string): + """ + Alias to re.split + """ + + return self.regex.split(string) + + def sub(self, sub, string, count=3D0): + """ + Alias to re.sub + """ + + return self.regex.sub(sub, string, count=3Dcount) + + def group(self, num): + """ + Returns the group results of the last match + """ + + return self.last_match.group(num) + + +class NestedMatch: + """ + Finding nested delimiters is hard with regular expressions. It is + even harder on Python with its normal re module, as there are several + advanced regular expressions that are missing. + + This is the case of this pattern: + + '\\bSTRUCT_GROUP(\\(((?:(?>[^)(]+)|(?1))*)\\))[^;]*;' + + which is used to properly match open/close parenthesis of the + string search STRUCT_GROUP(), + + Add a class that counts pairs of delimiters, using it to match and + replace nested expressions. + + The original approach was suggested by: + https://stackoverflow.com/questions/5454322/python-how-to-match-ne= sted-parentheses-with-regex + + Although I re-implemented it to make it more generic and match 3 types + of delimiters. The logic checks if delimiters are paired. If not, it + will ignore the search string. + """ + + # TODO: make NestedMatch handle multiple match groups + # + # Right now, regular expressions to match it are defined only up to + # the start delimiter, e.g.: + # + # \bSTRUCT_GROUP\( + # + # is similar to: STRUCT_GROUP\((.*)\) + # except that the content inside the match group is delimiter's aligne= d. + # + # The content inside parenthesis are converted into a single replace + # group (e.g. r`\1'). + # + # It would be nice to change such definition to support multiple + # match groups, allowing a regex equivalent to. + # + # FOO\((.*), (.*), (.*)\) + # + # it is probably easier to define it not as a regular expression, but + # with some lexical definition like: + # + # FOO(arg1, arg2, arg3) + + DELIMITER_PAIRS =3D { + '{': '}', + '(': ')', + '[': ']', + } + + RE_DELIM =3D re.compile(r'[\{\}\[\]\(\)]') + + def _search(self, regex, line): + """ + Finds paired blocks for a regex that ends with a delimiter. + + The suggestion of using finditer to match pairs came from: + https://stackoverflow.com/questions/5454322/python-how-to-match-ne= sted-parentheses-with-regex + but I ended using a different implementation to align all three ty= pes + of delimiters and seek for an initial regular expression. + + The algorithm seeks for open/close paired delimiters and place them + into a stack, yielding a start/stop position of each match when t= he + stack is zeroed. + + The algorithm shoud work fine for properly paired lines, but will + silently ignore end delimiters that preceeds an start delimiter. + This should be OK for kernel-doc parser, as unaligned delimiters + would cause compilation errors. So, we don't need to rise exceptio= ns + to cover such issues. + """ + + stack =3D [] + + for match_re in regex.finditer(line): + start =3D match_re.start() + offset =3D match_re.end() + + d =3D line[offset - 1] + if d not in self.DELIMITER_PAIRS: + continue + + end =3D self.DELIMITER_PAIRS[d] + stack.append(end) + + for match in self.RE_DELIM.finditer(line[offset:]): + pos =3D match.start() + offset + + d =3D line[pos] + + if d in self.DELIMITER_PAIRS: + end =3D self.DELIMITER_PAIRS[d] + + stack.append(end) + continue + + # Does the end delimiter match what it is expected? + if stack and d =3D=3D stack[-1]: + stack.pop() + + if not stack: + yield start, offset, pos + 1 + break + + def search(self, regex, line): + """ + This is similar to re.search: + + It matches a regex that it is followed by a delimiter, + returning occurrences only if all delimiters are paired. + """ + + for t in self._search(regex, line): + + yield line[t[0]:t[2]] + + def sub(self, regex, sub, line, count=3D0): + """ + This is similar to re.sub: + + It matches a regex that it is followed by a delimiter, + replacing occurrences only if all delimiters are paired. + + if r'\1' is used, it works just like re: it places there the + matched paired data with the delimiter stripped. + + If count is different than zero, it will replace at most count + items. + """ + out =3D "" + + cur_pos =3D 0 + n =3D 0 + + for start, end, pos in self._search(regex, line): + out +=3D line[cur_pos:start] + + # Value, ignoring start/end delimiters + value =3D line[end:pos - 1] + + # replaces \1 at the sub string, if \1 is used there + new_sub =3D sub + new_sub =3D new_sub.replace(r'\1', value) + + out +=3D new_sub + + # Drop end ';' if any + if line[pos] =3D=3D ';': + pos +=3D 1 + + cur_pos =3D pos + n +=3D 1 + + if count and count >=3D n: + break + + # Append the remaining string + l =3D len(line) + out +=3D line[cur_pos:l] + + return out --=20 2.43.0 From nobody Sat Nov 15 05:39:10 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1755191724; cv=none; d=zohomail.com; s=zohoarc; b=HSc0YxWfmCqkXYZruFLtISM52nX4aEFt7d5WKkBPGsQf8XAcpR1SCu/QiKs3box/NLzOCHIl0vf9P/uIYjz2VduPFbvO7S+scq5WwKeQf3UqiCbTmfry9t4U0HQiwZUjG6R4zfT+XJawG0L/n4Zrf7GvfAPSKw2hvG5D+Syl+zo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1755191724; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=Neh9mAADoZDyd4Cs2hypuhX5IvgeEVyNjiT+RnLWFZY=; b=QXqFP2/v5mwUl693ykppfuvlSR3ZxkJiox/zPU3mc4E+zwlxopmid30eag82KIKzwRqUE9E0ULhcqkOuSSBPNy9jiMIri+wq/JREvRixOdBdBFqsxj58B7JG7dCvE7DQN+krvYpzfFPmqP30f0arKr6QfVhmrwMrbY4PdB85syM= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1755191724054734.5448188723075; Thu, 14 Aug 2025 10:15:24 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1umbWD-0008LF-Jy; Thu, 14 Aug 2025 13:13:37 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1umbWA-0008Kc-Rq for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:34 -0400 Received: from mail-wm1-x32d.google.com ([2a00:1450:4864:20::32d]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1umbW8-0001oX-GW for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:34 -0400 Received: by mail-wm1-x32d.google.com with SMTP id 5b1f17b1804b1-45a1b00a65fso6104125e9.0 for ; Thu, 14 Aug 2025 10:13:31 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [2001:8b0:1d0::2]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-45a1c76e9basm29489165e9.21.2025.08.14.10.13.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Aug 2025 10:13:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1755191610; x=1755796410; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Neh9mAADoZDyd4Cs2hypuhX5IvgeEVyNjiT+RnLWFZY=; b=C9ETrMLNqzGwF1FYdjGsfP5JjTP3E7Pf1Y5cWJMQTc5qrG4gAiEQPCWDtcfO2J1v+r Ziy1GCudwvnGhQhWaLmd+Has9F61ZqPQrFxLNn3339o8IP3gQIMyiOLbLqxx1m+hEgZr GbpBegQnAq6hahvEWqdT4NldS6wniC+Wk5XcbgN/uI3jaOLbi8eCa118K75sfzfZhuY7 loWZMtGoVfCbtDUwCC9ed1zYSDzq2/0SVC6YI1tucmmC+MgenyMXb+uuLw9vXv/q+UJm /xCRRZlQfS6f4zgPZw+Z8sC1UKxQsmu73q3jLzvshxV4VnrJgyelEOTwnM7AP4Endz8B jUtw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1755191610; x=1755796410; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Neh9mAADoZDyd4Cs2hypuhX5IvgeEVyNjiT+RnLWFZY=; b=oRXlMyqbpFmmfVOsNXfCoYfZeRE4WPJuyU3+i352QCYoWvn92uqQYnIQZL9qjeJmcb rl9neMcb7gBbKlq3g4SKOy9NgaQJt0Ta1ZJyKGze/wYaBN53bwi0TVwzxXsaga/auNUi BRNqn3AJjmdHh1bcGlSCbhvQmu31nYNYP6jmTLdOIpeY+kqehZDTiRN5UHHqc4BDAW59 8idduw/BvnG5kdVC7MMJ2oKFxZRlAqAzLpcQAo5289PPOy5MsJnMPC1G73w5vEOMfJ9R /Xu62LeIrXZ12kKgtOhMqK2hFI/BN2rXgbkEOEOgJ4vmPGrbbDz6Y9Hw55PcnYyZGvG+ wriQ== X-Gm-Message-State: AOJu0YwCxKBwUdMOWvXrpJoxQ7sR/kbnpjTgoajhoP3xRCX7MhRqf3kb s452uKhjanYTgARg4L9fdod9v00xedauWbZk++pYxUd7M12EZSYdj4i1zBOtiKJLIwdtjjgA9eB 50Y0e X-Gm-Gg: ASbGncu3knelOZ+8QdI+oYwp3B+2ng9PagnrfCdgIPBGxhuwojZ74mL5fTr7q/RAnJT h5pWbEAMUVl8HpzE0oCgzISLEa2K2mHaRjlstgnGtV6uvm+AxuyGeLUz2w4cBa0f3NCoyaufWnp dNFjsgw9ofeEiFcJ+DofWddTXecSm4y6+dOY+QrjJZmYfVW6GociVearbD1Mwu0dPOv+BlFMxYI hqgl3ZYtJTJm2RqMpKXwpnTDkdEjFf8oU1wuiiVBGcGj628ZxQQZFuuIqprMeq92akFuDviU0MG K4znN+p6VCsmiKUf7Y7k0abK6xJBqD3IHUhoj7ugPteoHAjo/EkY2XQfvdenSE8TMgEDmKRRshr trJBXem0b9HDWQrvNu8hfdw/AEAhe X-Google-Smtp-Source: AGHT+IGEzDHY9svbzgmFQm54ULenG4qYfSCxDV8gFj7YnQ5URQKfmLK9U7hz9MhNtpzVk8wx4TtkdA== X-Received: by 2002:a05:600c:5486:b0:456:f00:4b5d with SMTP id 5b1f17b1804b1-45a1b649a68mr29197455e9.22.1755191610368; Thu, 14 Aug 2025 10:13:30 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Cc: Paolo Bonzini , John Snow Subject: [PATCH for-10.2 4/8] scripts/kernel-doc: strip QEMU_ from function definitions Date: Thu, 14 Aug 2025 18:13:19 +0100 Message-ID: <20250814171324.1614516-5-peter.maydell@linaro.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250814171324.1614516-1-peter.maydell@linaro.org> References: <20250814171324.1614516-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::32d; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x32d.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1755191725901124100 Content-Type: text/plain; charset="utf-8" This commit is the Python version of our older commit b30df2751e5 ("scripts/kernel-doc: strip QEMU_ from function definitions"). Some versions of Sphinx get confused if function attributes are left on the C code from kernel-doc; strip out any QEMU_* prefixes from function prototypes. Signed-off-by: Peter Maydell Reviewed-by: Mauro Carvalho Chehab Reviewed-by: Paolo Bonzini --- scripts/lib/kdoc/kdoc_parser.py | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/lib/kdoc/kdoc_parser.py b/scripts/lib/kdoc/kdoc_parser= .py index fe730099eca..32b43562929 100644 --- a/scripts/lib/kdoc/kdoc_parser.py +++ b/scripts/lib/kdoc/kdoc_parser.py @@ -907,6 +907,7 @@ def dump_function(self, ln, prototype): (r"^__always_inline +", "", 0), (r"^noinline +", "", 0), (r"^__FORTIFY_INLINE +", "", 0), + (r"QEMU_[A-Z_]+ +", "", 0), (r"__init +", "", 0), (r"__init_or_module +", "", 0), (r"__deprecated +", "", 0), --=20 2.43.0 From nobody Sat Nov 15 05:39:10 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1755191738; cv=none; d=zohomail.com; s=zohoarc; b=bEJtuJUpxF8ClWBvZ0TO0oRWXbfTB0JltWEhdQZKSTS/rT6jePvpT2tgLIcO2/3LPBiX2oQ67XixE7/XIIgl61y0NzVWB5W62JJ/ffbKMZDAXkbSXZXCUVIuI2TT1U5eC41eEdM7777q2bTHfHeRzeBo+IkPSTe0FQrUzGa/xp0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1755191738; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=GD2+pWQi5I5BSGyGawdBjG69hOWuCmkwcY8uG5kPViQ=; b=HObaY9QKD01EX0rthDEqRA5tdnkm+CKUI17ZKIlz+WPiAAIh+NLl90sKmFZGRXpKhy5YvdJjU9LhjKgefetlxyEp1pPeo/gYqqrW/iBGln4uc0mNOl41a+tsARf7vUM4BvfFkedjhN+OGcdk9GVhmnodhNmIkudY1Om5nmq8Xjs= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 17551917386189.926460534021203; Thu, 14 Aug 2025 10:15:38 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1umbWI-0008Ne-BI; Thu, 14 Aug 2025 13:13:42 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1umbWE-0008MK-Kw for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:39 -0400 Received: from mail-wr1-x436.google.com ([2a00:1450:4864:20::436]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1umbWC-0001ol-8b for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:38 -0400 Received: by mail-wr1-x436.google.com with SMTP id ffacd0b85a97d-3b9e41669d6so976215f8f.2 for ; Thu, 14 Aug 2025 10:13:34 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [2001:8b0:1d0::2]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-45a1c76e9basm29489165e9.21.2025.08.14.10.13.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Aug 2025 10:13:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1755191611; x=1755796411; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=GD2+pWQi5I5BSGyGawdBjG69hOWuCmkwcY8uG5kPViQ=; b=vmQSigdSc86+RGhldYbwVn5L2dmqyMWQTERgSuLWsFpUzjoyNHG5cLDh3KgZat4KBI RxAyCKVz1klOXAFPsDGlB56jpL6cRwog9yRjDBR7sVUyKhrEQCkUAmnV2ARcQXFreXgI cDJD6ceELk5Ml2u7uojXRYlDwvFX85ddXVi+LdWkFCuiAJVn27o75L/4j/imXViLH1yi 904SO2yTCn8wEzBKLOxbGt9ZSbIkIqB3sXtTj6O5sMbuGxQ2Y4wPztg+VCUBs+iL6iOv FS4trTjDcCmZ0mC/OTI5x6XhtY9v+tn/OT36oG16VmXFx/uWqisp4BVQLBqn4vdHNbgc J3Cg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1755191611; x=1755796411; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=GD2+pWQi5I5BSGyGawdBjG69hOWuCmkwcY8uG5kPViQ=; b=lxLgWb70RgzQ7SYiA23JsLfZMHbKe6vs3cGVS/34/Ym3ZRkiBe28JRwvN/eACPZHgK PnFuXJcxcpbE+7wetl5Zc3iY/oYsGJdNR7HqpV1iw//ylWgZq2XGDmWAJzo3RdtVtLRE tMY9cCZG84EA2rntgCdIq8T7i5eMoZrxAXbVo/nF38tk1gmHnb43avguC2YrRC3Sbgks KdGsTWrhggXqzxgzhgnoyC2j2b5WT9VRcqIsbMfNCrxQql6jKkLKy0X2wcIN/Lw421+/ oJk7SRYbHXWOoACk34M0fHB0GIWL8qo8KqpfzNfWItKMMByWmlzrO5Fc/9FW7FaKaBWt +qcQ== X-Gm-Message-State: AOJu0Yy8vbHYsRyK+bqIDahdjaW0Qt6HtZyhtlSh3HfpISTEgx7HnGWg 30Y5A2mOdCkE6xx9RR4f4Km+0mmnD0+CZi4WS0EiyXH3GpqRpb2DETVvAeoDJYkkWCNVY8+N1+2 UJYPd X-Gm-Gg: ASbGncsBfSOHwpppKeMcedqIDoxLE0gk8TaTTojDFX6RiHgjivm8vIY3a1CYexsuMne ntT/hg4XEu8U17IrNZNIBf/DIB5maXssN5ICczR8I+uOHeJ1+yrxOwYoM+gfh1jzXqsaJj3qfV7 544VRqGa2y7Mg3t3eXoJM49iXIjkAHvI5wac+EwMMHwzvMgbRiar3CQbmXvdi3gLGRdwQYWXbUZ 6uTzChrJU9tw1BpFZ7+xVYnbqwz+cXNlEQMrbutqqFqN86CV8clEZ2/fa3wIGVMZWecszfSpVO8 FgpJFIuNseXMGiVyF5AefQFYQuY9H+qCSspVeWCSGOTaWGXIqHfnUfmC7JPEvlZEDHKIOvbraNP LNA+EgnbltIcNnmwI3o9H2xJH/Xwa X-Google-Smtp-Source: AGHT+IH/32rKpvLeNK0K6BCleTZRnd6FhNqd09+p9dNjTx4Le5948KaeW6ccMCXgOcQU3ePqXevXjA== X-Received: by 2002:a5d:5d88:0:b0:3b8:d337:cc12 with SMTP id ffacd0b85a97d-3b9edf2c797mr3185489f8f.22.1755191611306; Thu, 14 Aug 2025 10:13:31 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Cc: Paolo Bonzini , John Snow Subject: [PATCH for-10.2 5/8] scripts/kernel-doc: tweak for QEMU coding standards Date: Thu, 14 Aug 2025 18:13:20 +0100 Message-ID: <20250814171324.1614516-6-peter.maydell@linaro.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250814171324.1614516-1-peter.maydell@linaro.org> References: <20250814171324.1614516-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::436; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x436.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1755191740059124100 Content-Type: text/plain; charset="utf-8" This commit makes the equivalent changes to the Python script that we had for the old Perl script in commit 4cf41794411f ("docs: tweak kernel-doc for QEMU coding standards"). To repeat the rationale from that commit: Surprisingly, QEMU does have a pretty consistent doc comment style and it is not very different from the Linux kernel's. Of the documentation "sigils", only "#" separates the QEMU doc comment style from Linux's, and it has 200+ instances vs. 6 for the kernel's '&struct foo' (all in accel/tcg/translate-all.c), so it's clear that the two standards are different in this respect. In addition, our structs are typedefed and recognized by CamelCase names. Note that in 4cf41794411f we used '(?!)' as our type_fallback regex; this is strictly not quite a replacement for the upstream '\&([_\w]+)', because the latter includes a group that can later be matched with \1, and the former does not. The old perl script did not care about this, but the python version does, so we must include the extra set of brackets to ensure we have a group. This commit does not include all the same changes that 4cf41794411f did. Of the missing pieces, some had already gone in an earlier kernel-doc update; the parts we still had but do not include here are: @@ -2057,7 +2060,7 @@ } elsif (/$doc_decl/o) { $identifier =3D $1; - if (/\s*([\w\s]+?)(\(\))?\s*-/) { + if (/\s*([\w\s]+?)(\s*-|:)/) { $identifier =3D $1; } @@ -2067,7 +2070,7 @@ $contents =3D ""; $section =3D $section_default; $new_start_line =3D $. + 1; - if (/-(.*)/) { + if (/[-:](.*)/) { # strip leading/trailing/multiple spaces $descr=3D $1; $descr =3D~ s/^\s*//; The second of these is already in the upstream version: the line r =3D KernRe("[-:](.*)") in process_name() matches the regex we have. The first change has been refactored into the doc_begin_data and doc_begin_func changes. Since the output HTML for QEMU's documentation has no relevant changes with the new kerneldoc, we assume that this too has been handled upstream. Signed-off-by: Peter Maydell Reviewed-by: Mauro Carvalho Chehab Reviewed-by: Paolo Bonzini --- scripts/lib/kdoc/kdoc_output.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/scripts/lib/kdoc/kdoc_output.py b/scripts/lib/kdoc/kdoc_output= .py index ea8914537ba..39fa872dfca 100644 --- a/scripts/lib/kdoc/kdoc_output.py +++ b/scripts/lib/kdoc/kdoc_output.py @@ -38,12 +38,12 @@ type_fp_param2 =3D KernRe(r"\@(\w+->\S+)\(\)", cache=3DFalse) =20 type_env =3D KernRe(r"(\$\w+)", cache=3DFalse) -type_enum =3D KernRe(r"\&(enum\s*([_\w]+))", cache=3DFalse) -type_struct =3D KernRe(r"\&(struct\s*([_\w]+))", cache=3DFalse) -type_typedef =3D KernRe(r"\&(typedef\s*([_\w]+))", cache=3DFalse) -type_union =3D KernRe(r"\&(union\s*([_\w]+))", cache=3DFalse) -type_member =3D KernRe(r"\&([_\w]+)(\.|->)([_\w]+)", cache=3DFalse) -type_fallback =3D KernRe(r"\&([_\w]+)", cache=3DFalse) +type_enum =3D KernRe(r"#(enum\s*([_\w]+))", cache=3DFalse) +type_struct =3D KernRe(r"#(struct\s*([_\w]+))", cache=3DFalse) +type_typedef =3D KernRe(r"#(([A-Z][_\w]*))", cache=3DFalse) +type_union =3D KernRe(r"#(union\s*([_\w]+))", cache=3DFalse) +type_member =3D KernRe(r"#([_\w]+)(\.|->)([_\w]+)", cache=3DFalse) +type_fallback =3D KernRe(r"((?!))", cache=3DFalse) # this never matches type_member_func =3D type_member + KernRe(r"\(\)", cache=3DFalse) =20 =20 --=20 2.43.0 From nobody Sat Nov 15 05:39:10 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1755191700; cv=none; d=zohomail.com; s=zohoarc; b=SvCken++1dl+p1KrMktGBGyNEZExiUqQXsfuqfyZwB1Ap2Dbd+OWdtcLhEG5zlZJXbaaoT314ujM+b4uGIpQS3UQ0cnDduRuHxbmMl86bEZ/qo85nPQ+rgTohmeTZ2eldGDpy/5qHUqwQfZbwprcm5Fa6GHaAks72RhcMeYXoGU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1755191700; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=rlI6Xx/AE/ROAA0bt/artH10PKzBzGyh+zWmu1Dz8WI=; b=E7MxUvVTh4mJg977Q0q+cOUp5rNS1Sp92zhZ0GLCzNZwl4tPnBkP1GIxU6DrF61LQVsC8le119dbpLkcg7K6KcArQZN5vwTTznlwtw8qCh1nCK42z7OmKjJskW4dC7yflt77l+z4WK4esMUR8uqhe4w0WUZj0bL+vC7m+Vci0A0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 175519170039147.22189949713095; Thu, 14 Aug 2025 10:15:00 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1umbWM-0008Ok-A3; Thu, 14 Aug 2025 13:13:46 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1umbWJ-0008OC-1x for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:44 -0400 Received: from mail-wm1-x332.google.com ([2a00:1450:4864:20::332]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1umbWC-0001p6-8l for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:42 -0400 Received: by mail-wm1-x332.google.com with SMTP id 5b1f17b1804b1-45a1ac7c066so7359275e9.1 for ; Thu, 14 Aug 2025 10:13:34 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [2001:8b0:1d0::2]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-45a1c76e9basm29489165e9.21.2025.08.14.10.13.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Aug 2025 10:13:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1755191612; x=1755796412; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=rlI6Xx/AE/ROAA0bt/artH10PKzBzGyh+zWmu1Dz8WI=; b=bSNdTOks2ITdmd71xAF6vWxp5vB56n6uf6tFxfG1yTjrpNyA0qlszAKREiFteZuAA+ BzmLUyd1X3K1BQns6gHLFxtIePlQZITSXE1bfLVOYUoQC3IqFAnn3V1uZ3PyA6uCMAbL 5kU8k9UfEFanUlvE0J8XIDJn54M8vnJTwnHTyfmFQsjBswnij/TFtcihNCEAVNo8Ji75 LUNf9ii8G8MQhBFl286ReeSptQbk5j6jxPln70ewNZrsU1liGqP3MVe6YoeExWtrsoSq euTv8OIOU9KbIoNWQT4RCH1ww0l7l4jPdm8PSkLru92W0qkEQWY9BaAjHOBFzxsQBaiC 72EA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1755191612; x=1755796412; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=rlI6Xx/AE/ROAA0bt/artH10PKzBzGyh+zWmu1Dz8WI=; b=F3InX1s2tcQnr+9/Gxth3f+kplpiVqt592L0ZkLapwCE3EDiV1rrv0QVi2Sgf48mrF 7g9mfQcP4ScM3mYINiYN3caBnRMwzJmWkxcrB7ksKkzzlOqvPXtNAOWkKknNKzvgl/XO nMMC7JUycqYAB1wM5II5KX9LXMXkfO8zKESC9EAy/qSLbUX2/qmxKJM9l3vymAY+s4lX CEsy+CdnszdHjWI/PheO1SCFC48El+AUGi3vWsh/baZgMlPzLLMr3HAbCP0fBgSjChZF k1E3nRdKH4jQq0AYsaoOUfv53ShmXoQ4QQwmXYOYpdxqwVW9uH/5Ur2mRB0GvKUVz9fd QxJA== X-Gm-Message-State: AOJu0YwvHZI1TsviiRzL9f9ZWZpg0GSgCR1v2PNXGuGiCV65IUZhFOFt dygoyBXSvldxr8om7yHZ7qep5WwWjwzaHBjnaVW1s8qgWwCiTYbO9r5Y0MucKSsTEhXISrYBw6f d7BHV X-Gm-Gg: ASbGncvHtEoyL8AvSAr9zGFGqzpJMMYY+O9F9kVwRa8PQyTheZYzsnCquRx0R0y4+E1 DV1/dtY6OT3TloV0akFyt+otUW2I645kI/+jBz4y+eICOClR1I2POCK6Uk3P9pjkwLNAXKIzdWE wICIPVAT2uSYV7M5m3IqOd5/tC9BYHYSUFWX9Bdke0NLUmC8heWPB61WhaYjtvNno97KvPYB6Gt NHqYN3gWZCqqocnG1HWUdMGt+4cgF/8UzEZiMbBqPiIfISJ0GDNzIQIMGDLUi5950/xGC2wrZGo vY6ckqJNkOdiBAahhE2X5dBET8VwB1v346bMBQWVR1g/yCgtrZSCyJhyx651RYlWCipjulOEQpx X40Cxe9Bmm1yQhqVcT6QxhJasM7Pc X-Google-Smtp-Source: AGHT+IG845PTqxgvwqGe6IMM51n0KWzVOQJ4nD4XyBW7YTpzsZaYAZs7kgzztHg6bKfr4pKsUDpZ+w== X-Received: by 2002:a05:600c:8283:b0:459:d9d5:7f2b with SMTP id 5b1f17b1804b1-45a1b7bf687mr34701265e9.16.1755191612252; Thu, 14 Aug 2025 10:13:32 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Cc: Paolo Bonzini , John Snow Subject: [PATCH for-10.2 6/8] scripts/kerneldoc: Switch to the Python kernel-doc script Date: Thu, 14 Aug 2025 18:13:21 +0100 Message-ID: <20250814171324.1614516-7-peter.maydell@linaro.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250814171324.1614516-1-peter.maydell@linaro.org> References: <20250814171324.1614516-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::332; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x332.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1755191702627116600 Content-Type: text/plain; charset="utf-8" Change the Sphinx config to run the new Python kernel-doc script instead of the Perl one. The only difference between the two is that the new script does not handle the -sphinx-version option, instead assuming that Sphinx is always at least version 3: so we must delete the code that passes that option to avoid the Python script complaining about an unknown option. QEMU's minimum Sphinx version is already 3.4.3, so this doesn't change the set of versions we can handle. Signed-off-by: Peter Maydell Reviewed-by: Paolo Bonzini --- For quite a long time during development of this patchseries I was still letting Sphinx invoke the new python script by calling perl, which will read the #! line and invoke env which then finds python3 and runs it... --- docs/conf.py | 4 +++- docs/sphinx/kerneldoc.py | 5 ----- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f892a6e1da3..e09769e5f83 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -341,7 +341,9 @@ # We use paths starting from qemu_docdir here so that you can run # sphinx-build from anywhere and the kerneldoc extension can still # find everything. -kerneldoc_bin =3D ['perl', os.path.join(qemu_docdir, '../scripts/kernel-do= c')] +# Since kernel-doc is now a Python script, we should run it with whatever +# Python this sphinx is using (rather than letting it find one via env) +kerneldoc_bin =3D [sys.executable, os.path.join(qemu_docdir, '../scripts/k= ernel-doc.py')] kerneldoc_srctree =3D os.path.join(qemu_docdir, '..') hxtool_srctree =3D os.path.join(qemu_docdir, '..') qapidoc_srctree =3D os.path.join(qemu_docdir, '..') diff --git a/docs/sphinx/kerneldoc.py b/docs/sphinx/kerneldoc.py index 30bb3431983..9721072e476 100644 --- a/docs/sphinx/kerneldoc.py +++ b/docs/sphinx/kerneldoc.py @@ -63,11 +63,6 @@ def run(self): env =3D self.state.document.settings.env cmd =3D env.config.kerneldoc_bin + ['-rst', '-enable-lineno'] =20 - # Pass the version string to kernel-doc, as it needs to use a diff= erent - # dialect, depending what the C domain supports for each specific - # Sphinx versions - cmd +=3D ['-sphinx-version', sphinx.__version__] - # Pass through the warnings-as-errors flag if env.config.kerneldoc_werror: cmd +=3D ['-Werror'] --=20 2.43.0 From nobody Sat Nov 15 05:39:10 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1755191754; cv=none; d=zohomail.com; s=zohoarc; b=EFJVQOVSSUBTdMO6EH73NiLx91CyQaeAztCzXbLBVlq9/1uaLK45LMY/zLRNea8MCXExf6AuiHdp1o1dgCJ4m08wxA7xlzWJn9Jg66JW+SEXmXUTsVnQ0s4nS9iP3jJGVXTvVbyHbsj4DpXy6DnULbCZy9xOldsu/qGkvEhD/LU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1755191754; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=y0DC3XNay64yLvgTiAgc7bYYfb27jr2kRs+HOFIuISU=; b=XuVdMw/c/X7bUVpTWI4WyDfobzHSGDqEd/pqX2RcTF9RQYk/sopMSrCiyrzN8M7cSbDjUY0PG+Fcghe9qK0uC5nHskRxcoh4llziYVFp045XoEqjPgbgHD7c+SZ72Bs9O3SbfoFo8F3bJZt9yCqj4LuRxtHtyYY9A8Ut3oZS5dI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1755191754500602.5530569964109; Thu, 14 Aug 2025 10:15:54 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1umbWM-0008Op-UB; Thu, 14 Aug 2025 13:13:47 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1umbWL-0008OL-53 for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:45 -0400 Received: from mail-wm1-x332.google.com ([2a00:1450:4864:20::332]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1umbWE-0001ps-09 for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:44 -0400 Received: by mail-wm1-x332.google.com with SMTP id 5b1f17b1804b1-45a1b004954so8435865e9.0 for ; Thu, 14 Aug 2025 10:13:36 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [2001:8b0:1d0::2]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-45a1c76e9basm29489165e9.21.2025.08.14.10.13.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Aug 2025 10:13:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1755191615; x=1755796415; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=y0DC3XNay64yLvgTiAgc7bYYfb27jr2kRs+HOFIuISU=; b=qQ0FZb6CCR8cXSRtqckSLmNHoteQt1HjjIWDOqETzwkHEe9T7WolLRGWaxMSunTRGZ RSTtwkkK5ZjI7H9XrXi7SLprD2QNukn0GwwUQS5U1Cf5Nb1vkAb6xAnU9cc12Pgsh22F W4TEn3WJ0ID5MLxhN1zr2Pc7lWxrF8A5wc+nUlbi4tg0Ax/TN7Dm5UmdpcQcK/l4MncA LPpCSHZLquwWSB+Ro6T0fo4Kj52f4hZxD/EVT1CNH5VzVyoGJ6wcZC2O769nZsOIzXMb +Jr3rEsIaslwi+UOuZSXOsSAQ5HNyNQm3azaZtCJB+teBqtBV1Wz/KxS6zesNo4bdcd9 GY+g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1755191615; x=1755796415; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=y0DC3XNay64yLvgTiAgc7bYYfb27jr2kRs+HOFIuISU=; b=fv3NnVxhv/wyVGvEoHmb1mbcHzBix1RM/fLKgmQ6VHJCrmF7t84UKcZ5gCPPuEyOwv ZBSnVv9fQq2rbCB7sPd8FKUzYlvW+y1Okqdtj8ctNGYP44yj3372aSi65kxmaRrzoJyd twvStOox5WzcWo9hhWqtJG/cHOrj6OcWzD7twizqsCiBuOrkxD3f2cJJnxVDjyBzquQP We16SBixHsLJ5hjSp/mANoN80CwO8NceDp4ILovm7P3Y3Zcns2i+jwt5teS7GCcR0u9+ 66hJ2H8fPA/Xu61wcAtYmKHecpeaN2yokC2kq8Je8Ea4E3cgYd1bLL2RydgzRrHV7bKe E+7Q== X-Gm-Message-State: AOJu0Yx4l2yulf3tOCE8FD3a4zNwUZIk+V4W2Bt3RPeZ2tfsEVBhSo0l TiH4xDB4UOccCv7XHO9akl8IfDchaOH+v6SxLlKjE5PbBjg+q2lqu/HpQe2ykKu7a9LSm53aaYe 2rw5R X-Gm-Gg: ASbGncu3dC/EBvZjTxljEmc66pm+TkkDlAdNhBJprGbNSuJbviAvggCfLAiqdxzXNzz 4Tp78sugndX++rT2HJDqyx7gmRNdCGO69mjFOcaCCwksZyKp3/gKoX9tgWURVRSZ9TfbNTWiwl0 1V7HpXQOXoZStR/jUTVDbMgowWU3qWMq32Lican+nkrCwGw2HRBBxOVQNv21wbQs34IOy9bO7mm 2K8xIEGO6/xWq0RhowdgyWPndCHDHs/NvIbphLQ3bE3LMotvlh2h224uz+SZNa+MEkTR+yZ+xlp MKZwmxyXldR2XGw+Z9w31p8Pk22G9ogXhR0KsE31CYrbYjgKhTAad97UG2F2U+AZSVyKJBueN4S CFAb7E+mUEiQDw3j1/w+k+/pvyOo5 X-Google-Smtp-Source: AGHT+IGRZlxVq2UVvsKu/UOhy6/T5/JX9zCN/ifmoR/dgpeJAo7Jj2iB58jTc3wftOGCsUTZsfELxQ== X-Received: by 2002:a05:600c:8707:b0:459:d709:e5d4 with SMTP id 5b1f17b1804b1-45a1b7f97e4mr37854525e9.0.1755191614049; Thu, 14 Aug 2025 10:13:34 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Cc: Paolo Bonzini , John Snow Subject: [PATCH for-10.2 7/8] scripts/kernel-doc: Delete the old Perl kernel-doc script Date: Thu, 14 Aug 2025 18:13:22 +0100 Message-ID: <20250814171324.1614516-8-peter.maydell@linaro.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250814171324.1614516-1-peter.maydell@linaro.org> References: <20250814171324.1614516-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::332; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x332.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1755191755410116600 Content-Type: text/plain; charset="utf-8" We can now delete the old Perl kernel-doc script. For posterity, this is a complete diff of the local changes that we were carrying between the kernel's Perl script as of kernel commit 72b97d0b911872ba (the last time we synced it) and our local copy: Reviewed-by: Mauro Carvalho Chehab Reviewed-by: Paolo Bonzini --- /tmp/kdoc 2025-08-14 10:42:47.620331939 +0100 +++ scripts/kernel-doc 2025-02-17 10:44:34.528421457 +0000 @@ -1,5 +1,5 @@ #!/usr/bin/env perl -# SPDX-License-Identifier: GPL-2.0 +# SPDX-License-Identifier: GPL-2.0-only use warnings; use strict; @@ -224,12 +224,12 @@ my $type_fp_param =3D '\@(\w+)\(\)'; # Special RST handling for func ptr = params my $type_fp_param2 =3D '\@(\w+->\S+)\(\)'; # Special RST handling for str= ucts with func ptr params my $type_env =3D '(\$\w+)'; -my $type_enum =3D '\&(enum\s*([_\w]+))'; -my $type_struct =3D '\&(struct\s*([_\w]+))'; -my $type_typedef =3D '\&(typedef\s*([_\w]+))'; -my $type_union =3D '\&(union\s*([_\w]+))'; -my $type_member =3D '\&([_\w]+)(\.|->)([_\w]+)'; -my $type_fallback =3D '\&([_\w]+)'; +my $type_enum =3D '#(enum\s*([_\w]+))'; +my $type_struct =3D '#(struct\s*([_\w]+))'; +my $type_typedef =3D '#(([A-Z][_\w]*))'; +my $type_union =3D '#(union\s*([_\w]+))'; +my $type_member =3D '#([_\w]+)(\.|->)([_\w]+)'; +my $type_fallback =3D '(?!)'; # this never matches my $type_member_func =3D $type_member . '\(\)'; # Output conversion substitutions. @@ -1745,6 +1745,9 @@ )+ \)\)\s+//x; + # Strip QEMU specific compiler annotations + $prototype =3D~ s/QEMU_[A-Z_]+ +//; + # Yes, this truly is vile. We are looking for: # 1. Return type (may be nothing if we're looking at a macro) # 2. Function name @@ -2057,7 +2060,7 @@ } elsif (/$doc_decl/o) { $identifier =3D $1; - if (/\s*([\w\s]+?)(\(\))?\s*-/) { + if (/\s*([\w\s]+?)(\s*-|:)/) { $identifier =3D $1; } @@ -2067,7 +2070,7 @@ $contents =3D ""; $section =3D $section_default; $new_start_line =3D $. + 1; - if (/-(.*)/) { + if (/[-:](.*)/) { # strip leading/trailing/multiple spaces $descr=3D $1; $descr =3D~ s/^\s*//; These changes correspond to: 06e2329636f license: Update deprecated SPDX tag GPL-2.0 to GPL-2.0-only (a bulk change which we won't bother to re-apply to this third-party script) b30df2751e5 scripts/kernel-doc: strip QEMU_ from function definitions 4cf41794411 docs: tweak kernel-doc for QEMU coding standards We have already applied the equivalent of these changes to the Python code in libs/kdoc/ in the preceding commits. Signed-off-by: Peter Maydell --- .editorconfig | 2 +- scripts/kernel-doc | 2442 -------------------------------------------- 2 files changed, 1 insertion(+), 2443 deletions(-) delete mode 100755 scripts/kernel-doc diff --git a/.editorconfig b/.editorconfig index a04cb9054cb..258d41ab485 100644 --- a/.editorconfig +++ b/.editorconfig @@ -55,7 +55,7 @@ indent_size =3D 4 emacs_mode =3D perl =20 # but user kernel "style" for imported scripts -[scripts/{kernel-doc,get_maintainer.pl,checkpatch.pl}] +[scripts/{get_maintainer.pl,checkpatch.pl}] indent_style =3D tab indent_size =3D 8 emacs_mode =3D perl diff --git a/scripts/kernel-doc b/scripts/kernel-doc deleted file mode 100755 index fec83f53eda..00000000000 --- a/scripts/kernel-doc +++ /dev/null @@ -1,2442 +0,0 @@ -#!/usr/bin/env perl -# SPDX-License-Identifier: GPL-2.0-only - -use warnings; -use strict; - -## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## -## Copyright (C) 2000, 1 Tim Waugh ## -## Copyright (C) 2001 Simon Huggins ## -## Copyright (C) 2005-2012 Randy Dunlap ## -## Copyright (C) 2012 Dan Luedtke ## -## ## -## #define enhancements by Armin Kuster ## -## Copyright (c) 2000 MontaVista Software, Inc. ## -## ## -## This software falls under the GNU General Public License. ## -## Please read the COPYING file for more information ## - -# 18/01/2001 - Cleanups -# Functions prototyped as foo(void) same as foo() -# Stop eval'ing where we don't need to. -# -- huggie@earth.li - -# 27/06/2001 - Allowed whitespace after initial "/**" and -# allowed comments before function declarations. -# -- Christian Kreibich - -# Still to do: -# - add perldoc documentation -# - Look more closely at some of the scarier bits :) - -# 26/05/2001 - Support for separate source and object trees. -# Return error code. -# Keith Owens - -# 23/09/2001 - Added support for typedefs, structs, enums and unions -# Support for Context section; can be terminated using empty = line -# Small fixes (like spaces vs. \s in regex) -# -- Tim Jansen - -# 25/07/2012 - Added support for HTML5 -# -- Dan Luedtke - -sub usage { - my $message =3D <<"EOF"; -Usage: $0 [OPTION ...] FILE ... - -Read C language source or header FILEs, extract embedded documentation com= ments, -and print formatted documentation to standard output. - -The documentation comments are identified by "/**" opening comment mark. S= ee -Documentation/doc-guide/kernel-doc.rst for the documentation comment synta= x. - -Output format selection (mutually exclusive): - -man Output troff manual page format. This is the default. - -rst Output reStructuredText format. - -none Do not output documentation, only warnings. - -Output format selection modifier (affects only ReST output): - - -sphinx-version Use the ReST C domain dialect compatible with an - specific Sphinx Version. - If not specified, kernel-doc will auto-detect using - the sphinx-build version found on PATH. - -Output selection (mutually exclusive): - -export Only output documentation for symbols that have been - exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() - in any input FILE or -export-file FILE. - -internal Only output documentation for symbols that have NOT been - exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() - in any input FILE or -export-file FILE. - -function NAME Only output documentation for the given function(s) - or DOC: section title(s). All other functions and DOC: - sections are ignored. May be specified multiple times. - -nosymbol NAME Exclude the specified symbols from the output - documentation. May be specified multiple times. - -Output selection modifiers: - -no-doc-sections Do not output DOC: sections. - -enable-lineno Enable output of #define LINENO lines. Only works = with - reStructuredText format. - -export-file FILE Specify an additional FILE in which to look for - EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be use= d with - -export or -internal. May be specified multiple ti= mes. - -Other parameters: - -v Verbose output, more warnings and other information. - -h Print this help. - -Werror Treat warnings as errors. - -EOF - print $message; - exit 1; -} - -# -# format of comments. -# In the following table, (...)? signifies optional structure. -# (...)* signifies 0 or more structure elements -# /** -# * function_name(:)? (- short description)? -# (* @parameterx: (description of parameter x)?)* -# (* a blank line)? -# * (Description:)? (Description of function)? -# * (section header: (section description)? )* -# (*)?*/ -# -# So .. the trivial example would be: -# -# /** -# * my_function -# */ -# -# If the Description: header tag is omitted, then there must be a blank li= ne -# after the last parameter specification. -# e.g. -# /** -# * my_function - does my stuff -# * @my_arg: its mine damnit -# * -# * Does my stuff explained. -# */ -# -# or, could also use: -# /** -# * my_function - does my stuff -# * @my_arg: its mine damnit -# * Description: Does my stuff explained. -# */ -# etc. -# -# Besides functions you can also write documentation for structs, unions, -# enums and typedefs. Instead of the function name you must write the name -# of the declaration; the struct/union/enum/typedef must always precede -# the name. Nesting of declarations is not supported. -# Use the argument mechanism to document members or constants. -# e.g. -# /** -# * struct my_struct - short description -# * @a: first member -# * @b: second member -# * -# * Longer description -# */ -# struct my_struct { -# int a; -# int b; -# /* private: */ -# int c; -# }; -# -# All descriptions can be multiline, except the short function description. -# -# For really longs structs, you can also describe arguments inside the -# body of the struct. -# eg. -# /** -# * struct my_struct - short description -# * @a: first member -# * @b: second member -# * -# * Longer description -# */ -# struct my_struct { -# int a; -# int b; -# /** -# * @c: This is longer description of C -# * -# * You can use paragraphs to describe arguments -# * using this method. -# */ -# int c; -# }; -# -# This should be use only for struct/enum members. -# -# You can also add additional sections. When documenting kernel functions = you -# should document the "Context:" of the function, e.g. whether the functio= ns -# can be called form interrupts. Unlike other sections you can end it with= an -# empty line. -# A non-void function should have a "Return:" section describing the return -# value(s). -# Example-sections should contain the string EXAMPLE so that they are mark= ed -# appropriately in DocBook. -# -# Example: -# /** -# * user_function - function that can only be called in user context -# * @a: some argument -# * Context: !in_interrupt() -# * -# * Some description -# * Example: -# * user_function(22); -# */ -# ... -# -# -# All descriptive text is further processed, scanning for the following sp= ecial -# patterns, which are highlighted appropriately. -# -# 'funcname()' - function -# '$ENVVAR' - environmental variable -# '&struct_name' - name of a structure (up to two words including 'struct') -# '&struct_name.member' - name of a structure member -# '@parameter' - name of a parameter -# '%CONST' - name of a constant. -# '``LITERAL``' - literal string without any spaces on it. - -## init lots of data - -my $errors =3D 0; -my $warnings =3D 0; -my $anon_struct_union =3D 0; - -# match expressions used to find embedded type information -my $type_constant =3D '\b``([^\`]+)``\b'; -my $type_constant2 =3D '\%([-_\w]+)'; -my $type_func =3D '(\w+)\(\)'; -my $type_param =3D '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; -my $type_param_ref =3D '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; -my $type_fp_param =3D '\@(\w+)\(\)'; # Special RST handling for func ptr = params -my $type_fp_param2 =3D '\@(\w+->\S+)\(\)'; # Special RST handling for str= ucts with func ptr params -my $type_env =3D '(\$\w+)'; -my $type_enum =3D '#(enum\s*([_\w]+))'; -my $type_struct =3D '#(struct\s*([_\w]+))'; -my $type_typedef =3D '#(([A-Z][_\w]*))'; -my $type_union =3D '#(union\s*([_\w]+))'; -my $type_member =3D '#([_\w]+)(\.|->)([_\w]+)'; -my $type_fallback =3D '(?!)'; # this never matches -my $type_member_func =3D $type_member . '\(\)'; - -# Output conversion substitutions. -# One for each output format - -# these are pretty rough -my @highlights_man =3D ( - [$type_constant, "\$1"], - [$type_constant2, "\$1"], - [$type_func, "\\\\fB\$1\\\\fP"], - [$type_enum, "\\\\fI\$1\\\\fP"], - [$type_struct, "\\\\fI\$1\\\\fP"], - [$type_typedef, "\\\\fI\$1\\\\fP"], - [$type_union, "\\\\fI\$1\\\\fP"], - [$type_param, "\\\\fI\$1\\\\fP"], - [$type_param_ref, "\\\\fI\$1\$2\\\\fP"], - [$type_member, "\\\\fI\$1\$2\$3\\\\fP"], - [$type_fallback, "\\\\fI\$1\\\\fP"] - ); -my $blankline_man =3D ""; - -# rst-mode -my @highlights_rst =3D ( - [$type_constant, "``\$1``"], - [$type_constant2, "``\$1``"], - # Note: need to escape () to avoid func matching la= ter - [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\= \\\) <\$1>`"], - [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"], - [$type_fp_param, "**\$1\\\\(\\\\)**"], - [$type_fp_param2, "**\$1\\\\(\\\\)**"], - [$type_func, "\$1()"], - [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"], - [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"], - [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"], - [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"], - # in rst this can refer to any type - [$type_fallback, "\\:c\\:type\\:`\$1`"], - [$type_param_ref, "**\$1\$2**"] - ); -my $blankline_rst =3D "\n"; - -# read arguments -if ($#ARGV =3D=3D -1) { - usage(); -} - -my $kernelversion; -my ($sphinx_major, $sphinx_minor, $sphinx_patch); - -my $dohighlight =3D ""; - -my $verbose =3D 0; -my $Werror =3D 0; -my $output_mode =3D "rst"; -my $output_preformatted =3D 0; -my $no_doc_sections =3D 0; -my $enable_lineno =3D 0; -my @highlights =3D @highlights_rst; -my $blankline =3D $blankline_rst; -my $modulename =3D "Kernel API"; - -use constant { - OUTPUT_ALL =3D> 0, # output all symbols and doc sections - OUTPUT_INCLUDE =3D> 1, # output only specified symbols - OUTPUT_EXPORTED =3D> 2, # output exported symbols - OUTPUT_INTERNAL =3D> 3, # output non-exported symbols -}; -my $output_selection =3D OUTPUT_ALL; -my $show_not_found =3D 0; # No longer used - -my @export_file_list; - -my @build_time; -if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) && - (my $seconds =3D `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '= ') { - @build_time =3D gmtime($seconds); -} else { - @build_time =3D localtime; -} - -my $man_date =3D ('January', 'February', 'March', 'April', 'May', 'June', - 'July', 'August', 'September', 'October', - 'November', 'December')[$build_time[4]] . - " " . ($build_time[5]+1900); - -# Essentially these are globals. -# They probably want to be tidied up, made more localised or something. -# CAVEAT EMPTOR! Some of the others I localised may not want to be, which -# could cause "use of undefined value" or other bugs. -my ($function, %function_table, %parametertypes, $declaration_purpose); -my %nosymbol_table =3D (); -my $declaration_start_line; -my ($type, $declaration_name, $return_type); -my ($newsection, $newcontents, $prototype, $brcount, %source_map); - -if (defined($ENV{'KBUILD_VERBOSE'})) { - $verbose =3D "$ENV{'KBUILD_VERBOSE'}"; -} - -if (defined($ENV{'KDOC_WERROR'})) { - $Werror =3D "$ENV{'KDOC_WERROR'}"; -} - -if (defined($ENV{'KCFLAGS'})) { - my $kcflags =3D "$ENV{'KCFLAGS'}"; - - if ($kcflags =3D~ /Werror/) { - $Werror =3D 1; - } -} - -# Generated docbook code is inserted in a template at a point where -# docbook v3.1 requires a non-zero sequence of RefEntry's; see: -# https://www.oasis-open.org/docbook/documentation/reference/html/refentry= .html -# We keep track of number of generated entries and generate a dummy -# if needs be to ensure the expanded template can be postprocessed -# into html. -my $section_counter =3D 0; - -my $lineprefix=3D""; - -# Parser states -use constant { - STATE_NORMAL =3D> 0, # normal code - STATE_NAME =3D> 1, # looking for function name - STATE_BODY_MAYBE =3D> 2, # body - or maybe more description - STATE_BODY =3D> 3, # the body of the comment - STATE_BODY_WITH_BLANK_LINE =3D> 4, # the body, which has a blank line - STATE_PROTO =3D> 5, # scanning prototype - STATE_DOCBLOCK =3D> 6, # documentation block - STATE_INLINE =3D> 7, # gathering doc outside main block -}; -my $state; -my $in_doc_sect; -my $leading_space; - -# Inline documentation state -use constant { - STATE_INLINE_NA =3D> 0, # not applicable ($state !=3D STATE_INLINE) - STATE_INLINE_NAME =3D> 1, # looking for member name (@foo:) - STATE_INLINE_TEXT =3D> 2, # looking for member documentation - STATE_INLINE_END =3D> 3, # done - STATE_INLINE_ERROR =3D> 4, # error - Comment without header was found. - # Spit a warning as it's not - # proper kernel-doc and ignore the rest. -}; -my $inline_doc_state; - -#declaration types: can be -# 'function', 'struct', 'union', 'enum', 'typedef' -my $decl_type; - -my $doc_start =3D '^/\*\*\s*$'; # Allow whitespace at end of comment start. -my $doc_end =3D '\*/'; -my $doc_com =3D '\s*\*\s*'; -my $doc_com_body =3D '\s*\* ?'; -my $doc_decl =3D $doc_com . '(\w+)'; -# @params and a strictly limited set of supported section names -my $doc_sect =3D $doc_com . - '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\= s*:(.*)'; -my $doc_content =3D $doc_com_body . '(.*)'; -my $doc_block =3D $doc_com . 'DOC:\s*(.*)?'; -my $doc_inline_start =3D '^\s*/\*\*\s*$'; -my $doc_inline_sect =3D '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)'; -my $doc_inline_end =3D '^\s*\*/\s*$'; -my $doc_inline_oneline =3D '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$'; -my $export_symbol =3D '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;'; - -my %parameterdescs; -my %parameterdesc_start_lines; -my @parameterlist; -my %sections; -my @sectionlist; -my %section_start_lines; -my $sectcheck; -my $struct_actual; - -my $contents =3D ""; -my $new_start_line =3D 0; - -# the canonical section names. see also $doc_sect above. -my $section_default =3D "Description"; # default section -my $section_intro =3D "Introduction"; -my $section =3D $section_default; -my $section_context =3D "Context"; -my $section_return =3D "Return"; - -my $undescribed =3D "-- undescribed --"; - -reset_state(); - -while ($ARGV[0] =3D~ m/^--?(.*)/) { - my $cmd =3D $1; - shift @ARGV; - if ($cmd eq "man") { - $output_mode =3D "man"; - @highlights =3D @highlights_man; - $blankline =3D $blankline_man; - } elsif ($cmd eq "rst") { - $output_mode =3D "rst"; - @highlights =3D @highlights_rst; - $blankline =3D $blankline_rst; - } elsif ($cmd eq "none") { - $output_mode =3D "none"; - } elsif ($cmd eq "module") { # not needed for XML, inherits from calli= ng document - $modulename =3D shift @ARGV; - } elsif ($cmd eq "function") { # to only output specific functions - $output_selection =3D OUTPUT_INCLUDE; - $function =3D shift @ARGV; - $function_table{$function} =3D 1; - } elsif ($cmd eq "nosymbol") { # Exclude specific symbols - my $symbol =3D shift @ARGV; - $nosymbol_table{$symbol} =3D 1; - } elsif ($cmd eq "export") { # only exported symbols - $output_selection =3D OUTPUT_EXPORTED; - %function_table =3D (); - } elsif ($cmd eq "internal") { # only non-exported symbols - $output_selection =3D OUTPUT_INTERNAL; - %function_table =3D (); - } elsif ($cmd eq "export-file") { - my $file =3D shift @ARGV; - push(@export_file_list, $file); - } elsif ($cmd eq "v") { - $verbose =3D 1; - } elsif ($cmd eq "Werror") { - $Werror =3D 1; - } elsif (($cmd eq "h") || ($cmd eq "help")) { - usage(); - } elsif ($cmd eq 'no-doc-sections') { - $no_doc_sections =3D 1; - } elsif ($cmd eq 'enable-lineno') { - $enable_lineno =3D 1; - } elsif ($cmd eq 'show-not-found') { - $show_not_found =3D 1; # A no-op but don't fail - } elsif ($cmd eq "sphinx-version") { - my $ver_string =3D shift @ARGV; - if ($ver_string =3D~ m/^(\d+)(\.\d+)?(\.\d+)?/) { - $sphinx_major =3D $1; - if (defined($2)) { - $sphinx_minor =3D substr($2,1); - } else { - $sphinx_minor =3D 0; - } - if (defined($3)) { - $sphinx_patch =3D substr($3,1) - } else { - $sphinx_patch =3D 0; - } - } else { - die "Sphinx version should either major.minor or major.minor.patch fo= rmat\n"; - } - } else { - # Unknown argument - usage(); - } -} - -# continue execution near EOF; - -# The C domain dialect changed on Sphinx 3. So, we need to check the -# version in order to produce the right tags. -sub findprog($) -{ - foreach(split(/:/, $ENV{PATH})) { - return "$_/$_[0]" if(-x "$_/$_[0]"); - } -} - -sub get_sphinx_version() -{ - my $ver; - - my $cmd =3D "sphinx-build"; - if (!findprog($cmd)) { - my $cmd =3D "sphinx-build3"; - if (!findprog($cmd)) { - $sphinx_major =3D 1; - $sphinx_minor =3D 2; - $sphinx_patch =3D 0; - printf STDERR "Warning: Sphinx version not found. Using default (Sphinx= version %d.%d.%d)\n", - $sphinx_major, $sphinx_minor, $sphinx_patch; - return; - } - } - - open IN, "$cmd --version 2>&1 |"; - while () { - if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) { - $sphinx_major =3D $1; - $sphinx_minor =3D $2; - $sphinx_patch =3D $3; - last; - } - # Sphinx 1.2.x uses a different format - if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) { - $sphinx_major =3D $1; - $sphinx_minor =3D $2; - $sphinx_patch =3D $3; - last; - } - } - close IN; -} - -# get kernel version from env -sub get_kernel_version() { - my $version =3D 'unknown kernel version'; - - if (defined($ENV{'KERNELVERSION'})) { - $version =3D $ENV{'KERNELVERSION'}; - } - return $version; -} - -# -sub print_lineno { - my $lineno =3D shift; - if ($enable_lineno && defined($lineno)) { - print "#define LINENO " . $lineno . "\n"; - } -} -## -# dumps section contents to arrays/hashes intended for that purpose. -# -sub dump_section { - my $file =3D shift; - my $name =3D shift; - my $contents =3D join "\n", @_; - - if ($name =3D~ m/$type_param/) { - $name =3D $1; - $parameterdescs{$name} =3D $contents; - $sectcheck =3D $sectcheck . $name . " "; - $parameterdesc_start_lines{$name} =3D $new_start_line; - $new_start_line =3D 0; - } elsif ($name eq "@\.\.\.") { - $name =3D "..."; - $parameterdescs{$name} =3D $contents; - $sectcheck =3D $sectcheck . $name . " "; - $parameterdesc_start_lines{$name} =3D $new_start_line; - $new_start_line =3D 0; - } else { - if (defined($sections{$name}) && ($sections{$name} ne "")) { - # Only warn on user specified duplicate section names. - if ($name ne $section_default) { - print STDERR "${file}:$.: warning: duplicate section name '$name'\n"; - ++$warnings; - } - $sections{$name} .=3D $contents; - } else { - $sections{$name} =3D $contents; - push @sectionlist, $name; - $section_start_lines{$name} =3D $new_start_line; - $new_start_line =3D 0; - } - } -} - -## -# dump DOC: section after checking that it should go out -# -sub dump_doc_section { - my $file =3D shift; - my $name =3D shift; - my $contents =3D join "\n", @_; - - if ($no_doc_sections) { - return; - } - - return if (defined($nosymbol_table{$name})); - - if (($output_selection =3D=3D OUTPUT_ALL) || - (($output_selection =3D=3D OUTPUT_INCLUDE) && - defined($function_table{$name}))) - { - dump_section($file, $name, $contents); - output_blockhead({'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'module' =3D> $modulename, - 'content-only' =3D> ($output_selection !=3D OUTPUT_ALL), }); - } -} - -## -# output function -# -# parameterdescs, a hash. -# function =3D> "function name" -# parameterlist =3D> @list of parameters -# parameterdescs =3D> %parameter descriptions -# sectionlist =3D> @list of sections -# sections =3D> %section descriptions -# - -sub output_highlight { - my $contents =3D join "\n",@_; - my $line; - -# DEBUG -# if (!defined $contents) { -# use Carp; -# confess "output_highlight got called with no args?\n"; -# } - -# print STDERR "contents b4:$contents\n"; - eval $dohighlight; - die $@ if $@; -# print STDERR "contents af:$contents\n"; - - foreach $line (split "\n", $contents) { - if (! $output_preformatted) { - $line =3D~ s/^\s*//; - } - if ($line eq ""){ - if (! $output_preformatted) { - print $lineprefix, $blankline; - } - } else { - if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { - print "\\&$line"; - } else { - print $lineprefix, $line; - } - } - print "\n"; - } -} - -## -# output function in man -sub output_function_man(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - my $count; - - print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\"= \"Kernel Hacker's Manual\" LINUX\n"; - - print ".SH NAME\n"; - print $args{'function'} . " \\- " . $args{'purpose'} . "\n"; - - print ".SH SYNOPSIS\n"; - if ($args{'functiontype'} ne "") { - print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n"; - } else { - print ".B \"" . $args{'function'} . "\n"; - } - $count =3D 0; - my $parenth =3D "("; - my $post =3D ","; - foreach my $parameter (@{$args{'parameterlist'}}) { - if ($count =3D=3D $#{$args{'parameterlist'}}) { - $post =3D ");"; - } - $type =3D $args{'parametertypes'}{$parameter}; - if ($type =3D~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { - # pointer-to-function - print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post = . "\"\n"; - } else { - $type =3D~ s/([^\*])$/$1 /; - print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n"; - } - $count++; - $parenth =3D ""; - } - - print ".SH ARGUMENTS\n"; - foreach $parameter (@{$args{'parameterlist'}}) { - my $parameter_name =3D $parameter; - $parameter_name =3D~ s/\[.*//; - - print ".IP \"" . $parameter . "\" 12\n"; - output_highlight($args{'parameterdescs'}{$parameter_name}); - } - foreach $section (@{$args{'sectionlist'}}) { - print ".SH \"", uc $section, "\"\n"; - output_highlight($args{'sections'}{$section}); - } -} - -## -# output enum in man -sub output_enum_man(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - my $count; - - print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" = \"API Manual\" LINUX\n"; - - print ".SH NAME\n"; - print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n"; - - print ".SH SYNOPSIS\n"; - print "enum " . $args{'enum'} . " {\n"; - $count =3D 0; - foreach my $parameter (@{$args{'parameterlist'}}) { - print ".br\n.BI \" $parameter\"\n"; - if ($count =3D=3D $#{$args{'parameterlist'}}) { - print "\n};\n"; - last; - } - else { - print ", \n.br\n"; - } - $count++; - } - - print ".SH Constants\n"; - foreach $parameter (@{$args{'parameterlist'}}) { - my $parameter_name =3D $parameter; - $parameter_name =3D~ s/\[.*//; - - print ".IP \"" . $parameter . "\" 12\n"; - output_highlight($args{'parameterdescs'}{$parameter_name}); - } - foreach $section (@{$args{'sectionlist'}}) { - print ".SH \"$section\"\n"; - output_highlight($args{'sections'}{$section}); - } -} - -## -# output struct in man -sub output_struct_man(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - - print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'st= ruct'} . "\" \"$man_date\" \"API Manual\" LINUX\n"; - - print ".SH NAME\n"; - print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose= '} . "\n"; - - my $declaration =3D $args{'definition'}; - $declaration =3D~ s/\t/ /g; - $declaration =3D~ s/\n/"\n.br\n.BI \"/g; - print ".SH SYNOPSIS\n"; - print $args{'type'} . " " . $args{'struct'} . " {\n.br\n"; - print ".BI \"$declaration\n};\n.br\n\n"; - - print ".SH Members\n"; - foreach $parameter (@{$args{'parameterlist'}}) { - ($parameter =3D~ /^#/) && next; - - my $parameter_name =3D $parameter; - $parameter_name =3D~ s/\[.*//; - - ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; - print ".IP \"" . $parameter . "\" 12\n"; - output_highlight($args{'parameterdescs'}{$parameter_name}); - } - foreach $section (@{$args{'sectionlist'}}) { - print ".SH \"$section\"\n"; - output_highlight($args{'sections'}{$section}); - } -} - -## -# output typedef in man -sub output_typedef_man(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - - print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"= API Manual\" LINUX\n"; - - print ".SH NAME\n"; - print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n= "; - - foreach $section (@{$args{'sectionlist'}}) { - print ".SH \"$section\"\n"; - output_highlight($args{'sections'}{$section}); - } -} - -sub output_blockhead_man(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - my $count; - - print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"A= PI Manual\" LINUX\n"; - - foreach $section (@{$args{'sectionlist'}}) { - print ".SH \"$section\"\n"; - output_highlight($args{'sections'}{$section}); - } -} - -## -# output in restructured text -# - -# -# This could use some work; it's used to output the DOC: sections, and -# starts by putting out the name of the doc section itself, but that tends -# to duplicate a header already in the template file. -# -sub output_blockhead_rst(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - - foreach $section (@{$args{'sectionlist'}}) { - next if (defined($nosymbol_table{$section})); - - if ($output_selection !=3D OUTPUT_INCLUDE) { - print "**$section**\n\n"; - } - print_lineno($section_start_lines{$section}); - output_highlight_rst($args{'sections'}{$section}); - print "\n"; - } -} - -# -# Apply the RST highlights to a sub-block of text. -# -sub highlight_block($) { - # The dohighlight kludge requires the text be called $contents - my $contents =3D shift; - eval $dohighlight; - die $@ if $@; - return $contents; -} - -# -# Regexes used only here. -# -my $sphinx_literal =3D '^[^.].*::$'; -my $sphinx_cblock =3D '^\.\.\ +code-block::'; - -sub output_highlight_rst { - my $input =3D join "\n",@_; - my $output =3D ""; - my $line; - my $in_literal =3D 0; - my $litprefix; - my $block =3D ""; - - foreach $line (split "\n",$input) { - # - # If we're in a literal block, see if we should drop out - # of it. Otherwise pass the line straight through unmunged. - # - if ($in_literal) { - if (! ($line =3D~ /^\s*$/)) { - # - # If this is the first non-blank line in a literal - # block we need to figure out what the proper indent is. - # - if ($litprefix eq "") { - $line =3D~ /^(\s*)/; - $litprefix =3D '^' . $1; - $output .=3D $line . "\n"; - } elsif (! ($line =3D~ /$litprefix/)) { - $in_literal =3D 0; - } else { - $output .=3D $line . "\n"; - } - } else { - $output .=3D $line . "\n"; - } - } - # - # Not in a literal block (or just dropped out) - # - if (! $in_literal) { - $block .=3D $line . "\n"; - if (($line =3D~ /$sphinx_literal/) || ($line =3D~ /$sphinx_cblock/)) { - $in_literal =3D 1; - $litprefix =3D ""; - $output .=3D highlight_block($block); - $block =3D "" - } - } - } - - if ($block) { - $output .=3D highlight_block($block); - } - foreach $line (split "\n", $output) { - print $lineprefix . $line . "\n"; - } -} - -sub output_function_rst(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - my $oldprefix =3D $lineprefix; - my $start =3D ""; - my $is_macro =3D 0; - - if ($sphinx_major < 3) { - if ($args{'typedef'}) { - print ".. c:type:: ". $args{'function'} . "\n\n"; - print_lineno($declaration_start_line); - print " **Typedef**: "; - $lineprefix =3D ""; - output_highlight_rst($args{'purpose'}); - $start =3D "\n\n**Syntax**\n\n ``"; - $is_macro =3D 1; - } else { - print ".. c:function:: "; - } - } else { - if ($args{'typedef'} || $args{'functiontype'} eq "") { - $is_macro =3D 1; - print ".. c:macro:: ". $args{'function'} . "\n\n"; - } else { - print ".. c:function:: "; - } - - if ($args{'typedef'}) { - print_lineno($declaration_start_line); - print " **Typedef**: "; - $lineprefix =3D ""; - output_highlight_rst($args{'purpose'}); - $start =3D "\n\n**Syntax**\n\n ``"; - } else { - print "``" if ($is_macro); - } - } - if ($args{'functiontype'} ne "") { - $start .=3D $args{'functiontype'} . " " . $args{'function'} . " ("; - } else { - $start .=3D $args{'function'} . " ("; - } - print $start; - - my $count =3D 0; - foreach my $parameter (@{$args{'parameterlist'}}) { - if ($count ne 0) { - print ", "; - } - $count++; - $type =3D $args{'parametertypes'}{$parameter}; - - if ($type =3D~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { - # pointer-to-function - print $1 . $parameter . ") (" . $2 . ")"; - } else { - print $type; - } - } - if ($is_macro) { - print ")``\n\n"; - } else { - print ")\n\n"; - } - if (!$args{'typedef'}) { - print_lineno($declaration_start_line); - $lineprefix =3D " "; - output_highlight_rst($args{'purpose'}); - print "\n"; - } - - print "**Parameters**\n\n"; - $lineprefix =3D " "; - foreach $parameter (@{$args{'parameterlist'}}) { - my $parameter_name =3D $parameter; - $parameter_name =3D~ s/\[.*//; - $type =3D $args{'parametertypes'}{$parameter}; - - if ($type ne "") { - print "``$type``\n"; - } else { - print "``$parameter``\n"; - } - - print_lineno($parameterdesc_start_lines{$parameter_name}); - - if (defined($args{'parameterdescs'}{$parameter_name}) && - $args{'parameterdescs'}{$parameter_name} ne $undescribed) { - output_highlight_rst($args{'parameterdescs'}{$parameter_name}); - } else { - print " *undescribed*\n"; - } - print "\n"; - } - - $lineprefix =3D $oldprefix; - output_section_rst(@_); -} - -sub output_section_rst(%) { - my %args =3D %{$_[0]}; - my $section; - my $oldprefix =3D $lineprefix; - $lineprefix =3D ""; - - foreach $section (@{$args{'sectionlist'}}) { - print "**$section**\n\n"; - print_lineno($section_start_lines{$section}); - output_highlight_rst($args{'sections'}{$section}); - print "\n"; - } - print "\n"; - $lineprefix =3D $oldprefix; -} - -sub output_enum_rst(%) { - my %args =3D %{$_[0]}; - my ($parameter); - my $oldprefix =3D $lineprefix; - my $count; - - if ($sphinx_major < 3) { - my $name =3D "enum " . $args{'enum'}; - print "\n\n.. c:type:: " . $name . "\n\n"; - } else { - my $name =3D $args{'enum'}; - print "\n\n.. c:enum:: " . $name . "\n\n"; - } - print_lineno($declaration_start_line); - $lineprefix =3D " "; - output_highlight_rst($args{'purpose'}); - print "\n"; - - print "**Constants**\n\n"; - $lineprefix =3D " "; - foreach $parameter (@{$args{'parameterlist'}}) { - print "``$parameter``\n"; - if ($args{'parameterdescs'}{$parameter} ne $undescribed) { - output_highlight_rst($args{'parameterdescs'}{$parameter}); - } else { - print " *undescribed*\n"; - } - print "\n"; - } - - $lineprefix =3D $oldprefix; - output_section_rst(@_); -} - -sub output_typedef_rst(%) { - my %args =3D %{$_[0]}; - my ($parameter); - my $oldprefix =3D $lineprefix; - my $name; - - if ($sphinx_major < 3) { - $name =3D "typedef " . $args{'typedef'}; - } else { - $name =3D $args{'typedef'}; - } - print "\n\n.. c:type:: " . $name . "\n\n"; - print_lineno($declaration_start_line); - $lineprefix =3D " "; - output_highlight_rst($args{'purpose'}); - print "\n"; - - $lineprefix =3D $oldprefix; - output_section_rst(@_); -} - -sub output_struct_rst(%) { - my %args =3D %{$_[0]}; - my ($parameter); - my $oldprefix =3D $lineprefix; - - if ($sphinx_major < 3) { - my $name =3D $args{'type'} . " " . $args{'struct'}; - print "\n\n.. c:type:: " . $name . "\n\n"; - } else { - my $name =3D $args{'struct'}; - if ($args{'type'} eq 'union') { - print "\n\n.. c:union:: " . $name . "\n\n"; - } else { - print "\n\n.. c:struct:: " . $name . "\n\n"; - } - } - print_lineno($declaration_start_line); - $lineprefix =3D " "; - output_highlight_rst($args{'purpose'}); - print "\n"; - - print "**Definition**\n\n"; - print "::\n\n"; - my $declaration =3D $args{'definition'}; - $declaration =3D~ s/\t/ /g; - print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration= };\n\n"; - - print "**Members**\n\n"; - $lineprefix =3D " "; - foreach $parameter (@{$args{'parameterlist'}}) { - ($parameter =3D~ /^#/) && next; - - my $parameter_name =3D $parameter; - $parameter_name =3D~ s/\[.*//; - - ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; - $type =3D $args{'parametertypes'}{$parameter}; - print_lineno($parameterdesc_start_lines{$parameter_name}); - print "``" . $parameter . "``\n"; - output_highlight_rst($args{'parameterdescs'}{$parameter_name}); - print "\n"; - } - print "\n"; - - $lineprefix =3D $oldprefix; - output_section_rst(@_); -} - -## none mode output functions - -sub output_function_none(%) { -} - -sub output_enum_none(%) { -} - -sub output_typedef_none(%) { -} - -sub output_struct_none(%) { -} - -sub output_blockhead_none(%) { -} - -## -# generic output function for all types (function, struct/union, typedef, = enum); -# calls the generated, variable output_ function name based on -# functype and output_mode -sub output_declaration { - no strict 'refs'; - my $name =3D shift; - my $functype =3D shift; - my $func =3D "output_${functype}_$output_mode"; - - return if (defined($nosymbol_table{$name})); - - if (($output_selection =3D=3D OUTPUT_ALL) || - (($output_selection =3D=3D OUTPUT_INCLUDE || - $output_selection =3D=3D OUTPUT_EXPORTED) && - defined($function_table{$name})) || - ($output_selection =3D=3D OUTPUT_INTERNAL && - !($functype eq "function" && defined($function_table{$name})))) - { - &$func(@_); - $section_counter++; - } -} - -## -# generic output function - calls the right one based on current output mo= de. -sub output_blockhead { - no strict 'refs'; - my $func =3D "output_blockhead_" . $output_mode; - &$func(@_); - $section_counter++; -} - -## -# takes a declaration (struct, union, enum, typedef) and -# invokes the right handler. NOT called for functions. -sub dump_declaration($$) { - no strict 'refs'; - my ($prototype, $file) =3D @_; - my $func =3D "dump_" . $decl_type; - &$func(@_); -} - -sub dump_union($$) { - dump_struct(@_); -} - -sub dump_struct($$) { - my $x =3D shift; - my $file =3D shift; - - if ($x =3D~ /(struct|union)\s+(\w+)\s*\{(.*)\}(\s*(__packed|__aligned|= ____cacheline_aligned_in_smp|____cacheline_aligned|__attribute__\s*\(\([a-z= 0-9,_\s\(\)]*\)\)))*/) { - my $decl_type =3D $1; - $declaration_name =3D $2; - my $members =3D $3; - - # ignore members marked private: - $members =3D~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; - $members =3D~ s/\/\*\s*private:.*//gosi; - # strip comments: - $members =3D~ s/\/\*.*?\*\///gos; - # strip attributes - $members =3D~ s/\s*__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)/ /gi; - $members =3D~ s/\s*__aligned\s*\([^;]*\)/ /gos; - $members =3D~ s/\s*__packed\s*/ /gos; - $members =3D~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos; - $members =3D~ s/\s*____cacheline_aligned_in_smp/ /gos; - $members =3D~ s/\s*____cacheline_aligned/ /gos; - - # replace DECLARE_BITMAP - $members =3D~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_B= ITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos; - $members =3D~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $= 1\[BITS_TO_LONGS($2)\]/gos; - # replace DECLARE_HASHTABLE - $members =3D~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned lon= g $1\[1 << (($2) - 1)\]/gos; - # replace DECLARE_KFIFO - $members =3D~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \= *$1/gos; - # replace DECLARE_KFIFO_PTR - $members =3D~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos; - - my $declaration =3D $members; - - # Split nested struct/union elements as newer ones - while ($members =3D~ m/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*= )\;/) { - my $newmember; - my $maintype =3D $1; - my $ids =3D $4; - my $content =3D $3; - foreach my $id(split /,/, $ids) { - $newmember .=3D "$maintype $id; "; - - $id =3D~ s/[:\[].*//; - $id =3D~ s/^\s*\**(\S+)\s*/$1/; - foreach my $arg (split /;/, $content) { - next if ($arg =3D~ m/^\s*$/); - if ($arg =3D~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) { - # pointer-to-function - my $type =3D $1; - my $name =3D $2; - my $extra =3D $3; - next if (!$name); - if ($id =3D~ m/^\s*$/) { - # anonymous struct/union - $newmember .=3D "$type$name$extra; "; - } else { - $newmember .=3D "$type$id.$name$extra; "; - } - } else { - my $type; - my $names; - $arg =3D~ s/^\s+//; - $arg =3D~ s/\s+$//; - # Handle bitmaps - $arg =3D~ s/:\s*\d+\s*//g; - # Handle arrays - $arg =3D~ s/\[.*\]//g; - # The type may have multiple words, - # and multiple IDs can be defined, like: - # const struct foo, *bar, foobar - # So, we remove spaces when parsing the - # names, in order to match just names - # and commas for the names - $arg =3D~ s/\s*,\s*/,/g; - if ($arg =3D~ m/(.*)\s+([\S+,]+)/) { - $type =3D $1; - $names =3D $2; - } else { - $newmember .=3D "$arg; "; - next; - } - foreach my $name (split /,/, $names) { - $name =3D~ s/^\s*\**(\S+)\s*/$1/; - next if (($name =3D~ m/^\s*$/)); - if ($id =3D~ m/^\s*$/) { - # anonymous struct/union - $newmember .=3D "$type $name; "; - } else { - $newmember .=3D "$type $id.$name; "; - } - } - } - } - } - $members =3D~ s/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/$n= ewmember/; - } - - # Ignore other nested elements, like enums - $members =3D~ s/(\{[^\{\}]*\})//g; - - create_parameterlist($members, ';', $file, $declaration_name); - check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_= actual); - - # Adjust declaration for better display - $declaration =3D~ s/([\{;])/$1\n/g; - $declaration =3D~ s/\}\s+;/};/g; - # Better handle inlined enums - do {} while ($declaration =3D~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/); - - my @def_args =3D split /\n/, $declaration; - my $level =3D 1; - $declaration =3D ""; - foreach my $clause (@def_args) { - $clause =3D~ s/^\s+//; - $clause =3D~ s/\s+$//; - $clause =3D~ s/\s+/ /; - next if (!$clause); - $level-- if ($clause =3D~ m/(\})/ && $level > 1); - if (!($clause =3D~ m/^\s*#/)) { - $declaration .=3D "\t" x $level; - } - $declaration .=3D "\t" . $clause . "\n"; - $level++ if ($clause =3D~ m/(\{)/ && !($clause =3D~m/\}/)); - } - output_declaration($declaration_name, - 'struct', - {'struct' =3D> $declaration_name, - 'module' =3D> $modulename, - 'definition' =3D> $declaration, - 'parameterlist' =3D> \@parameterlist, - 'parameterdescs' =3D> \%parameterdescs, - 'parametertypes' =3D> \%parametertypes, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose, - 'type' =3D> $decl_type - }); - } - else { - print STDERR "${file}:$.: error: Cannot parse struct or union!\n"; - ++$errors; - } -} - - -sub show_warnings($$) { - my $functype =3D shift; - my $name =3D shift; - - return 0 if (defined($nosymbol_table{$name})); - - return 1 if ($output_selection =3D=3D OUTPUT_ALL); - - if ($output_selection =3D=3D OUTPUT_EXPORTED) { - if (defined($function_table{$name})) { - return 1; - } else { - return 0; - } - } - if ($output_selection =3D=3D OUTPUT_INTERNAL) { - if (!($functype eq "function" && defined($function_table{$name}))) { - return 1; - } else { - return 0; - } - } - if ($output_selection =3D=3D OUTPUT_INCLUDE) { - if (defined($function_table{$name})) { - return 1; - } else { - return 0; - } - } - die("Please add the new output type at show_warnings()"); -} - -sub dump_enum($$) { - my $x =3D shift; - my $file =3D shift; - my $members; - - - $x =3D~ s@/\*.*?\*/@@gos; # strip comments. - # strip #define macros inside enums - $x =3D~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos; - - if ($x =3D~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) { - $declaration_name =3D $2; - $members =3D $1; - } elsif ($x =3D~ /enum\s+(\w*)\s*\{(.*)\}/) { - $declaration_name =3D $1; - $members =3D $2; - } - - if ($declaration_name) { - my %_members; - - $members =3D~ s/\s+$//; - - foreach my $arg (split ',', $members) { - $arg =3D~ s/^\s*(\w+).*/$1/; - push @parameterlist, $arg; - if (!$parameterdescs{$arg}) { - $parameterdescs{$arg} =3D $undescribed; - if (show_warnings("enum", $declaration_name)) { - print STDERR "${file}:$.: warning: Enum value '$arg' not described in e= num '$declaration_name'\n"; - } - } - $_members{$arg} =3D 1; - } - - while (my ($k, $v) =3D each %parameterdescs) { - if (!exists($_members{$k})) { - if (show_warnings("enum", $declaration_name)) { - print STDERR "${file}:$.: warning: Excess enum value '$k' descripti= on in '$declaration_name'\n"; - } - } - } - - output_declaration($declaration_name, - 'enum', - {'enum' =3D> $declaration_name, - 'module' =3D> $modulename, - 'parameterlist' =3D> \@parameterlist, - 'parameterdescs' =3D> \%parameterdescs, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose - }); - } else { - print STDERR "${file}:$.: error: Cannot parse enum!\n"; - ++$errors; - } -} - -my $typedef_type =3D qr { ((?:\s+[\w\*]+){1,8})\s* }x; -my $typedef_ident =3D qr { \*?\s*(\w\S+)\s* }x; -my $typedef_args =3D qr { \s*\((.*)\); }x; - -my $typedef1 =3D qr { typedef$typedef_type\($typedef_ident\)$typedef_args = }x; -my $typedef2 =3D qr { typedef$typedef_type$typedef_ident$typedef_args }x; - -sub dump_typedef($$) { - my $x =3D shift; - my $file =3D shift; - - $x =3D~ s@/\*.*?\*/@@gos; # strip comments. - - # Parse function typedef prototypes - if ($x =3D~ $typedef1 || $x =3D~ $typedef2) { - $return_type =3D $1; - $declaration_name =3D $2; - my $args =3D $3; - $return_type =3D~ s/^\s+//; - - create_parameterlist($args, ',', $file, $declaration_name); - - output_declaration($declaration_name, - 'function', - {'function' =3D> $declaration_name, - 'typedef' =3D> 1, - 'module' =3D> $modulename, - 'functiontype' =3D> $return_type, - 'parameterlist' =3D> \@parameterlist, - 'parameterdescs' =3D> \%parameterdescs, - 'parametertypes' =3D> \%parametertypes, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose - }); - return; - } - - while (($x =3D~ /\(*.\)\s*;$/) || ($x =3D~ /\[*.\]\s*;$/)) { - $x =3D~ s/\(*.\)\s*;$/;/; - $x =3D~ s/\[*.\]\s*;$/;/; - } - - if ($x =3D~ /typedef.*\s+(\w+)\s*;/) { - $declaration_name =3D $1; - - output_declaration($declaration_name, - 'typedef', - {'typedef' =3D> $declaration_name, - 'module' =3D> $modulename, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose - }); - } - else { - print STDERR "${file}:$.: error: Cannot parse typedef!\n"; - ++$errors; - } -} - -sub save_struct_actual($) { - my $actual =3D shift; - - # strip all spaces from the actual param so that it looks like one str= ing item - $actual =3D~ s/\s*//g; - $struct_actual =3D $struct_actual . $actual . " "; -} - -sub create_parameterlist($$$$) { - my $args =3D shift; - my $splitter =3D shift; - my $file =3D shift; - my $declaration_name =3D shift; - my $type; - my $param; - - # temporarily replace commas inside function pointer definition - while ($args =3D~ /(\([^\),]+),/) { - $args =3D~ s/(\([^\),]+),/$1#/g; - } - - foreach my $arg (split($splitter, $args)) { - # strip comments - $arg =3D~ s/\/\*.*\*\///; - # strip leading/trailing spaces - $arg =3D~ s/^\s*//; - $arg =3D~ s/\s*$//; - $arg =3D~ s/\s+/ /; - - if ($arg =3D~ /^#/) { - # Treat preprocessor directive as a typeless variable just to fill - # corresponding data structures "correctly". Catch it later in - # output_* subs. - push_parameter($arg, "", "", $file); - } elsif ($arg =3D~ m/\(.+\)\s*\(/) { - # pointer-to-function - $arg =3D~ tr/#/,/; - $arg =3D~ m/[^\(]+\(\*?\s*([\w\.]*)\s*\)/; - $param =3D $1; - $type =3D $arg; - $type =3D~ s/([^\(]+\(\*?)\s*$param/$1/; - save_struct_actual($param); - push_parameter($param, $type, $arg, $file, $declaration_name); - } elsif ($arg) { - $arg =3D~ s/\s*:\s*/:/g; - $arg =3D~ s/\s*\[/\[/g; - - my @args =3D split('\s*,\s*', $arg); - if ($args[0] =3D~ m/\*/) { - $args[0] =3D~ s/(\*+)\s*/ $1/; - } - - my @first_arg; - if ($args[0] =3D~ /^(.*\s+)(.*?\[.*\].*)$/) { - shift @args; - push(@first_arg, split('\s+', $1)); - push(@first_arg, $2); - } else { - @first_arg =3D split('\s+', shift @args); - } - - unshift(@args, pop @first_arg); - $type =3D join " ", @first_arg; - - foreach $param (@args) { - if ($param =3D~ m/^(\*+)\s*(.*)/) { - save_struct_actual($2); - - push_parameter($2, "$type $1", $arg, $file, $declaration_name); - } - elsif ($param =3D~ m/(.*?):(\d+)/) { - if ($type ne "") { # skip unnamed bit-fields - save_struct_actual($1); - push_parameter($1, "$type:$2", $arg, $file, $declaration_name) - } - } - else { - save_struct_actual($param); - push_parameter($param, $type, $arg, $file, $declaration_name); - } - } - } - } -} - -sub push_parameter($$$$$) { - my $param =3D shift; - my $type =3D shift; - my $org_arg =3D shift; - my $file =3D shift; - my $declaration_name =3D shift; - - if (($anon_struct_union =3D=3D 1) && ($type eq "") && - ($param eq "}")) { - return; # ignore the ending }; from anon. struct/union - } - - $anon_struct_union =3D 0; - $param =3D~ s/[\[\)].*//; - - if ($type eq "" && $param =3D~ /\.\.\.$/) - { - if (!$param =3D~ /\w\.\.\.$/) { - # handles unnamed variable parameters - $param =3D "..."; - } - elsif ($param =3D~ /\w\.\.\.$/) { - # for named variable parameters of the form `x...`, remove the dots - $param =3D~ s/\.\.\.$//; - } - if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq ""= ) { - $parameterdescs{$param} =3D "variable arguments"; - } - } - elsif ($type eq "" && ($param eq "" or $param eq "void")) - { - $param=3D"void"; - $parameterdescs{void} =3D "no arguments"; - } - elsif ($type eq "" && ($param eq "struct" or $param eq "union")) - # handle unnamed (anonymous) union or struct: - { - $type =3D $param; - $param =3D "{unnamed_" . $param . "}"; - $parameterdescs{$param} =3D "anonymous\n"; - $anon_struct_union =3D 1; - } - - # warn if parameter has no description - # (but ignore ones starting with # as these are not parameters - # but inline preprocessor statements); - # Note: It will also ignore void params and unnamed structs/unions - if (!defined $parameterdescs{$param} && $param !~ /^#/) { - $parameterdescs{$param} =3D $undescribed; - - if (show_warnings($type, $declaration_name) && $param !~ /\./) { - print STDERR - "${file}:$.: warning: Function parameter or member '$param' not d= escribed in '$declaration_name'\n"; - ++$warnings; - } - } - - # strip spaces from $param so that it is one continuous string - # on @parameterlist; - # this fixes a problem where check_sections() cannot find - # a parameter like "addr[6 + 2]" because it actually appears - # as "addr[6", "+", "2]" on the parameter list; - # but it's better to maintain the param string unchanged for output, - # so just weaken the string compare in check_sections() to ignore - # "[blah" in a parameter string; - ###$param =3D~ s/\s*//g; - push @parameterlist, $param; - $org_arg =3D~ s/\s\s+/ /g; - $parametertypes{$param} =3D $org_arg; -} - -sub check_sections($$$$$) { - my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) =3D @_; - my @sects =3D split ' ', $sectcheck; - my @prms =3D split ' ', $prmscheck; - my $err; - my ($px, $sx); - my $prm_clean; # strip trailing "[array size]" and/or beginning "*" - - foreach $sx (0 .. $#sects) { - $err =3D 1; - foreach $px (0 .. $#prms) { - $prm_clean =3D $prms[$px]; - $prm_clean =3D~ s/\[.*\]//; - $prm_clean =3D~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; - # ignore array size in a parameter string; - # however, the original param string may contain - # spaces, e.g.: addr[6 + 2] - # and this appears in @prms as "addr[6" since the - # parameter list is split at spaces; - # hence just ignore "[..." for the sections check; - $prm_clean =3D~ s/\[.*//; - - ##$prm_clean =3D~ s/^\**//; - if ($prm_clean eq $sects[$sx]) { - $err =3D 0; - last; - } - } - if ($err) { - if ($decl_type eq "function") { - print STDERR "${file}:$.: warning: " . - "Excess function parameter " . - "'$sects[$sx]' " . - "description in '$decl_name'\n"; - ++$warnings; - } - } - } -} - -## -# Checks the section describing the return value of a function. -sub check_return_section { - my $file =3D shift; - my $declaration_name =3D shift; - my $return_type =3D shift; - - # Ignore an empty return type (It's a macro) - # Ignore functions with a "void" return type. (But don't ignore "v= oid *") - if (($return_type eq "") || ($return_type =3D~ /void\s*\w*\s*$/)) { - return; - } - - if (!defined($sections{$section_return}) || - $sections{$section_return} eq "") { - print STDERR "${file}:$.: warning: " . - "No description found for return value of " . - "'$declaration_name'\n"; - ++$warnings; - } -} - -## -# takes a function prototype and the name of the current file being -# processed and spits out all the details stored in the global -# arrays/hashes. -sub dump_function($$) { - my $prototype =3D shift; - my $file =3D shift; - my $noret =3D 0; - - print_lineno($new_start_line); - - $prototype =3D~ s/^static +//; - $prototype =3D~ s/^extern +//; - $prototype =3D~ s/^asmlinkage +//; - $prototype =3D~ s/^inline +//; - $prototype =3D~ s/^__inline__ +//; - $prototype =3D~ s/^__inline +//; - $prototype =3D~ s/^__always_inline +//; - $prototype =3D~ s/^noinline +//; - $prototype =3D~ s/__init +//; - $prototype =3D~ s/__init_or_module +//; - $prototype =3D~ s/__meminit +//; - $prototype =3D~ s/__must_check +//; - $prototype =3D~ s/__weak +//; - $prototype =3D~ s/__sched +//; - $prototype =3D~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//; - my $define =3D $prototype =3D~ s/^#\s*define\s+//; #ak added - $prototype =3D~ s/__attribute__\s*\(\( - (?: - [\w\s]++ # attribute name - (?:\([^)]*+\))? # attribute arguments - \s*+,? # optional comma at the end - )+ - \)\)\s+//x; - - # Strip QEMU specific compiler annotations - $prototype =3D~ s/QEMU_[A-Z_]+ +//; - - # Yes, this truly is vile. We are looking for: - # 1. Return type (may be nothing if we're looking at a macro) - # 2. Function name - # 3. Function parameters. - # - # All the while we have to watch out for function pointer parameters - # (which IIRC is what the two sections are for), C types (these - # regexps don't even start to express all the possibilities), and - # so on. - # - # If you mess with these regexps, it's a good idea to check that - # the following functions' documentation still comes out right: - # - parport_register_device (function pointer parameters) - # - atomic_set (macro) - # - pci_match_device, __copy_to_user (long return type) - - if ($define && $prototype =3D~ m/^()([a-zA-Z0-9_~:]+)\s+/) { - # This is an object-like macro, it has no return type and no param= eter - # list. - # Function-like macros are not allowed to have spaces between - # declaration_name and opening parenthesis (notice the \s+). - $return_type =3D $1; - $declaration_name =3D $2; - $noret =3D 1; - } elsif ($prototype =3D~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || - $prototype =3D~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || - $prototype =3D~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || - $prototype =3D~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || - $prototype =3D~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ = || - $prototype =3D~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ = || - $prototype =3D~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]= *)\)/ || - $prototype =3D~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || - $prototype =3D~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || - $prototype =3D~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || - $prototype =3D~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || - $prototype =3D~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ = || - $prototype =3D~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ = || - $prototype =3D~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]= *)\)/ || - $prototype =3D~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]= *)\)/ || - $prototype =3D~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(= ([^\{]*)\)/ || - $prototype =3D~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s= *\(([^\{]*)\)/) { - $return_type =3D $1; - $declaration_name =3D $2; - my $args =3D $3; - - create_parameterlist($args, ',', $file, $declaration_name); - } else { - print STDERR "${file}:$.: warning: cannot understand function prototype: = '$prototype'\n"; - return; - } - - my $prms =3D join " ", @parameterlist; - check_sections($file, $declaration_name, "function", $sectcheck, $prms= ); - - # This check emits a lot of warnings at the moment, because many - # functions don't have a 'Return' doc section. So until the number - # of warnings goes sufficiently down, the check is only performed in - # verbose mode. - # TODO: always perform the check. - if ($verbose && !$noret) { - check_return_section($file, $declaration_name, $return_type); - } - - # The function parser can be called with a typedef parameter. - # Handle it. - if ($return_type =3D~ /typedef/) { - output_declaration($declaration_name, - 'function', - {'function' =3D> $declaration_name, - 'typedef' =3D> 1, - 'module' =3D> $modulename, - 'functiontype' =3D> $return_type, - 'parameterlist' =3D> \@parameterlist, - 'parameterdescs' =3D> \%parameterdescs, - 'parametertypes' =3D> \%parametertypes, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose - }); - } else { - output_declaration($declaration_name, - 'function', - {'function' =3D> $declaration_name, - 'module' =3D> $modulename, - 'functiontype' =3D> $return_type, - 'parameterlist' =3D> \@parameterlist, - 'parameterdescs' =3D> \%parameterdescs, - 'parametertypes' =3D> \%parametertypes, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose - }); - } -} - -sub reset_state { - $function =3D ""; - %parameterdescs =3D (); - %parametertypes =3D (); - @parameterlist =3D (); - %sections =3D (); - @sectionlist =3D (); - $sectcheck =3D ""; - $struct_actual =3D ""; - $prototype =3D ""; - - $state =3D STATE_NORMAL; - $inline_doc_state =3D STATE_INLINE_NA; -} - -sub tracepoint_munge($) { - my $file =3D shift; - my $tracepointname =3D 0; - my $tracepointargs =3D 0; - - if ($prototype =3D~ m/TRACE_EVENT\((.*?),/) { - $tracepointname =3D $1; - } - if ($prototype =3D~ m/DEFINE_SINGLE_EVENT\((.*?),/) { - $tracepointname =3D $1; - } - if ($prototype =3D~ m/DEFINE_EVENT\((.*?),(.*?),/) { - $tracepointname =3D $2; - } - $tracepointname =3D~ s/^\s+//; #strip leading whitespace - if ($prototype =3D~ m/TP_PROTO\((.*?)\)/) { - $tracepointargs =3D $1; - } - if (($tracepointname eq 0) || ($tracepointargs eq 0)) { - print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n". - "$prototype\n"; - } else { - $prototype =3D "static inline void trace_$tracepointname($tracepointargs= )"; - } -} - -sub syscall_munge() { - my $void =3D 0; - - $prototype =3D~ s@[\r\n]+@ @gos; # strip newlines/CR's -## if ($prototype =3D~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { - if ($prototype =3D~ m/SYSCALL_DEFINE0/) { - $void =3D 1; -## $prototype =3D "long sys_$1(void)"; - } - - $prototype =3D~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func= name - if ($prototype =3D~ m/long (sys_.*?),/) { - $prototype =3D~ s/,/\(/; - } elsif ($void) { - $prototype =3D~ s/\)/\(void\)/; - } - - # now delete all of the odd-number commas in $prototype - # so that arg types & arg names don't have a comma between them - my $count =3D 0; - my $len =3D length($prototype); - if ($void) { - $len =3D 0; # skip the for-loop - } - for (my $ix =3D 0; $ix < $len; $ix++) { - if (substr($prototype, $ix, 1) eq ',') { - $count++; - if ($count % 2 =3D=3D 1) { - substr($prototype, $ix, 1) =3D ' '; - } - } - } -} - -sub process_proto_function($$) { - my $x =3D shift; - my $file =3D shift; - - $x =3D~ s@\/\/.*$@@gos; # strip C99-style comments to end of line - - if ($x =3D~ m#\s*/\*\s+MACDOC\s*#io || ($x =3D~ /^#/ && $x !~ /^#\s*de= fine/)) { - # do nothing - } - elsif ($x =3D~ /([^\{]*)/) { - $prototype .=3D $1; - } - - if (($x =3D~ /\{/) || ($x =3D~ /\#\s*define/) || ($x =3D~ /;/)) { - $prototype =3D~ s@/\*.*?\*/@@gos; # strip comments. - $prototype =3D~ s@[\r\n]+@ @gos; # strip newlines/cr's. - $prototype =3D~ s@^\s+@@gos; # strip leading spaces - - # Handle prototypes for function pointers like: - # int (*pcs_config)(struct foo) - $prototype =3D~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos; - - if ($prototype =3D~ /SYSCALL_DEFINE/) { - syscall_munge(); - } - if ($prototype =3D~ /TRACE_EVENT/ || $prototype =3D~ /DEFINE_EVENT/ || - $prototype =3D~ /DEFINE_SINGLE_EVENT/) - { - tracepoint_munge($file); - } - dump_function($prototype, $file); - reset_state(); - } -} - -sub process_proto_type($$) { - my $x =3D shift; - my $file =3D shift; - - $x =3D~ s@[\r\n]+@ @gos; # strip newlines/cr's. - $x =3D~ s@^\s+@@gos; # strip leading spaces - $x =3D~ s@\s+$@@gos; # strip trailing spaces - $x =3D~ s@\/\/.*$@@gos; # strip C99-style comments to end of line - - if ($x =3D~ /^#/) { - # To distinguish preprocessor directive from regular declaration later. - $x .=3D ";"; - } - - while (1) { - if ( $x =3D~ /([^\{\};]*)([\{\};])(.*)/ ) { - if( length $prototype ) { - $prototype .=3D " " - } - $prototype .=3D $1 . $2; - ($2 eq '{') && $brcount++; - ($2 eq '}') && $brcount--; - if (($2 eq ';') && ($brcount =3D=3D 0)) { - dump_declaration($prototype, $file); - reset_state(); - last; - } - $x =3D $3; - } else { - $prototype .=3D $x; - last; - } - } -} - - -sub map_filename($) { - my $file; - my ($orig_file) =3D @_; - - if (defined($ENV{'SRCTREE'})) { - $file =3D "$ENV{'SRCTREE'}" . "/" . $orig_file; - } else { - $file =3D $orig_file; - } - - if (defined($source_map{$file})) { - $file =3D $source_map{$file}; - } - - return $file; -} - -sub process_export_file($) { - my ($orig_file) =3D @_; - my $file =3D map_filename($orig_file); - - if (!open(IN,"<$file")) { - print STDERR "Error: Cannot open file $file\n"; - ++$errors; - return; - } - - while () { - if (/$export_symbol/) { - next if (defined($nosymbol_table{$2})); - $function_table{$2} =3D 1; - } - } - - close(IN); -} - -# -# Parsers for the various processing states. -# -# STATE_NORMAL: looking for the /** to begin everything. -# -sub process_normal() { - if (/$doc_start/o) { - $state =3D STATE_NAME; # next line is always the function name - $in_doc_sect =3D 0; - $declaration_start_line =3D $. + 1; - } -} - -# -# STATE_NAME: Looking for the "name - description" line -# -sub process_name($$) { - my $file =3D shift; - my $identifier; - my $descr; - - if (/$doc_block/o) { - $state =3D STATE_DOCBLOCK; - $contents =3D ""; - $new_start_line =3D $.; - - if ( $1 eq "" ) { - $section =3D $section_intro; - } else { - $section =3D $1; - } - } - elsif (/$doc_decl/o) { - $identifier =3D $1; - if (/\s*([\w\s]+?)(\s*-|:)/) { - $identifier =3D $1; - } - - $state =3D STATE_BODY; - # if there's no @param blocks need to set up default section - # here - $contents =3D ""; - $section =3D $section_default; - $new_start_line =3D $. + 1; - if (/[-:](.*)/) { - # strip leading/trailing/multiple spaces - $descr=3D $1; - $descr =3D~ s/^\s*//; - $descr =3D~ s/\s*$//; - $descr =3D~ s/\s+/ /g; - $declaration_purpose =3D $descr; - $state =3D STATE_BODY_MAYBE; - } else { - $declaration_purpose =3D ""; - } - - if (($declaration_purpose eq "") && $verbose) { - print STDERR "${file}:$.: warning: missing initial short description = on line:\n"; - print STDERR $_; - ++$warnings; - } - - if ($identifier =3D~ m/^struct\b/) { - $decl_type =3D 'struct'; - } elsif ($identifier =3D~ m/^union\b/) { - $decl_type =3D 'union'; - } elsif ($identifier =3D~ m/^enum\b/) { - $decl_type =3D 'enum'; - } elsif ($identifier =3D~ m/^typedef\b/) { - $decl_type =3D 'typedef'; - } else { - $decl_type =3D 'function'; - } - - if ($verbose) { - print STDERR "${file}:$.: info: Scanning doc for $identifier\n"; - } - } else { - print STDERR "${file}:$.: warning: Cannot understand $_ on line $.", - " - I thought it was a doc line\n"; - ++$warnings; - $state =3D STATE_NORMAL; - } -} - - -# -# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment. -# -sub process_body($$) { - my $file =3D shift; - - # Until all named variable macro parameters are - # documented using the bare name (`x`) rather than with - # dots (`x...`), strip the dots: - if ($section =3D~ /\w\.\.\.$/) { - $section =3D~ s/\.\.\.$//; - - if ($verbose) { - print STDERR "${file}:$.: warning: Variable macro arguments should be= documented without dots\n"; - ++$warnings; - } - } - - if ($state =3D=3D STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) { - dump_section($file, $section, $contents); - $section =3D $section_default; - $new_start_line =3D $.; - $contents =3D ""; - } - - if (/$doc_sect/i) { # case insensitive for supported section names - $newsection =3D $1; - $newcontents =3D $2; - - # map the supported section names to the canonical names - if ($newsection =3D~ m/^description$/i) { - $newsection =3D $section_default; - } elsif ($newsection =3D~ m/^context$/i) { - $newsection =3D $section_context; - } elsif ($newsection =3D~ m/^returns?$/i) { - $newsection =3D $section_return; - } elsif ($newsection =3D~ m/^\@return$/) { - # special: @return is a section, not a param description - $newsection =3D $section_return; - } - - if (($contents ne "") && ($contents ne "\n")) { - if (!$in_doc_sect && $verbose) { - print STDERR "${file}:$.: warning: contents before sections\n"; - ++$warnings; - } - dump_section($file, $section, $contents); - $section =3D $section_default; - } - - $in_doc_sect =3D 1; - $state =3D STATE_BODY; - $contents =3D $newcontents; - $new_start_line =3D $.; - while (substr($contents, 0, 1) eq " ") { - $contents =3D substr($contents, 1); - } - if ($contents ne "") { - $contents .=3D "\n"; - } - $section =3D $newsection; - $leading_space =3D undef; - } elsif (/$doc_end/) { - if (($contents ne "") && ($contents ne "\n")) { - dump_section($file, $section, $contents); - $section =3D $section_default; - $contents =3D ""; - } - # look for doc_com + + doc_end: - if ($_ =3D~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { - print STDERR "${file}:$.: warning: suspicious ending line: $_"; - ++$warnings; - } - - $prototype =3D ""; - $state =3D STATE_PROTO; - $brcount =3D 0; - $new_start_line =3D $. + 1; - } elsif (/$doc_content/) { - if ($1 eq "") { - if ($section eq $section_context) { - dump_section($file, $section, $contents); - $section =3D $section_default; - $contents =3D ""; - $new_start_line =3D $.; - $state =3D STATE_BODY; - } else { - if ($section ne $section_default) { - $state =3D STATE_BODY_WITH_BLANK_LINE; - } else { - $state =3D STATE_BODY; - } - $contents .=3D "\n"; - } - } elsif ($state =3D=3D STATE_BODY_MAYBE) { - # Continued declaration purpose - chomp($declaration_purpose); - $declaration_purpose .=3D " " . $1; - $declaration_purpose =3D~ s/\s+/ /g; - } else { - my $cont =3D $1; - if ($section =3D~ m/^@/ || $section eq $section_context) { - if (!defined $leading_space) { - if ($cont =3D~ m/^(\s+)/) { - $leading_space =3D $1; - } else { - $leading_space =3D ""; - } - } - $cont =3D~ s/^$leading_space//; - } - $contents .=3D $cont . "\n"; - } - } else { - # i dont know - bad line? ignore. - print STDERR "${file}:$.: warning: bad line: $_"; - ++$warnings; - } -} - - -# -# STATE_PROTO: reading a function/whatever prototype. -# -sub process_proto($$) { - my $file =3D shift; - - if (/$doc_inline_oneline/) { - $section =3D $1; - $contents =3D $2; - if ($contents ne "") { - $contents .=3D "\n"; - dump_section($file, $section, $contents); - $section =3D $section_default; - $contents =3D ""; - } - } elsif (/$doc_inline_start/) { - $state =3D STATE_INLINE; - $inline_doc_state =3D STATE_INLINE_NAME; - } elsif ($decl_type eq 'function') { - process_proto_function($_, $file); - } else { - process_proto_type($_, $file); - } -} - -# -# STATE_DOCBLOCK: within a DOC: block. -# -sub process_docblock($$) { - my $file =3D shift; - - if (/$doc_end/) { - dump_doc_section($file, $section, $contents); - $section =3D $section_default; - $contents =3D ""; - $function =3D ""; - %parameterdescs =3D (); - %parametertypes =3D (); - @parameterlist =3D (); - %sections =3D (); - @sectionlist =3D (); - $prototype =3D ""; - $state =3D STATE_NORMAL; - } elsif (/$doc_content/) { - if ( $1 eq "" ) { - $contents .=3D $blankline; - } else { - $contents .=3D $1 . "\n"; - } - } -} - -# -# STATE_INLINE: docbook comments within a prototype. -# -sub process_inline($$) { - my $file =3D shift; - - # First line (state 1) needs to be a @parameter - if ($inline_doc_state =3D=3D STATE_INLINE_NAME && /$doc_inline_sect/o)= { - $section =3D $1; - $contents =3D $2; - $new_start_line =3D $.; - if ($contents ne "") { - while (substr($contents, 0, 1) eq " ") { - $contents =3D substr($contents, 1); - } - $contents .=3D "\n"; - } - $inline_doc_state =3D STATE_INLINE_TEXT; - # Documentation block end */ - } elsif (/$doc_inline_end/) { - if (($contents ne "") && ($contents ne "\n")) { - dump_section($file, $section, $contents); - $section =3D $section_default; - $contents =3D ""; - } - $state =3D STATE_PROTO; - $inline_doc_state =3D STATE_INLINE_NA; - # Regular text - } elsif (/$doc_content/) { - if ($inline_doc_state =3D=3D STATE_INLINE_TEXT) { - $contents .=3D $1 . "\n"; - # nuke leading blank lines - if ($contents =3D~ /^\s*$/) { - $contents =3D ""; - } - } elsif ($inline_doc_state =3D=3D STATE_INLINE_NAME) { - $inline_doc_state =3D STATE_INLINE_ERROR; - print STDERR "${file}:$.: warning: "; - print STDERR "Incorrect use of kernel-doc format: $_"; - ++$warnings; - } - } -} - - -sub process_file($) { - my $file; - my $initial_section_counter =3D $section_counter; - my ($orig_file) =3D @_; - - $file =3D map_filename($orig_file); - - if (!open(IN_FILE,"<$file")) { - print STDERR "Error: Cannot open file $file\n"; - ++$errors; - return; - } - - $. =3D 1; - - $section_counter =3D 0; - while () { - while (s/\\\s*$//) { - $_ .=3D ; - } - # Replace tabs by spaces - while ($_ =3D~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}; - # Hand this line to the appropriate state handler - if ($state =3D=3D STATE_NORMAL) { - process_normal(); - } elsif ($state =3D=3D STATE_NAME) { - process_name($file, $_); - } elsif ($state =3D=3D STATE_BODY || $state =3D=3D STATE_BODY_MAYBE || - $state =3D=3D STATE_BODY_WITH_BLANK_LINE) { - process_body($file, $_); - } elsif ($state =3D=3D STATE_INLINE) { # scanning for inline parameters - process_inline($file, $_); - } elsif ($state =3D=3D STATE_PROTO) { - process_proto($file, $_); - } elsif ($state =3D=3D STATE_DOCBLOCK) { - process_docblock($file, $_); - } - } - - # Make sure we got something interesting. - if ($initial_section_counter =3D=3D $section_counter && $ - output_mode ne "none") { - if ($output_selection =3D=3D OUTPUT_INCLUDE) { - print STDERR "${file}:1: warning: '$_' not found\n" - for keys %function_table; - } - else { - print STDERR "${file}:1: warning: no structured comments found\n"; - } - } - close IN_FILE; -} - - -if ($output_mode eq "rst") { - get_sphinx_version() if (!$sphinx_major); -} - -$kernelversion =3D get_kernel_version(); - -# generate a sequence of code that will splice in highlighting information -# using the s// operator. -for (my $k =3D 0; $k < @highlights; $k++) { - my $pattern =3D $highlights[$k][0]; - my $result =3D $highlights[$k][1]; -# print STDERR "scanning pattern:$pattern, highlight:($result)\n"; - $dohighlight .=3D "\$contents =3D~ s:$pattern:$result:gs;\n"; -} - -# Read the file that maps relative names to absolute names for -# separate source and object directories and for shadow trees. -if (open(SOURCE_MAP, "<.tmp_filelist.txt")) { - my ($relname, $absname); - while() { - chop(); - ($relname, $absname) =3D (split())[0..1]; - $relname =3D~ s:^/+::; - $source_map{$relname} =3D $absname; - } - close(SOURCE_MAP); -} - -if ($output_selection =3D=3D OUTPUT_EXPORTED || - $output_selection =3D=3D OUTPUT_INTERNAL) { - - push(@export_file_list, @ARGV); - - foreach (@export_file_list) { - chomp; - process_export_file($_); - } -} - -foreach (@ARGV) { - chomp; - process_file($_); -} -if ($verbose && $errors) { - print STDERR "$errors errors\n"; -} -if ($verbose && $warnings) { - print STDERR "$warnings warnings\n"; -} - -if ($Werror && $warnings) { - print STDERR "$warnings warnings as Errors\n"; - exit($warnings); -} else { - exit($output_mode eq "none" ? 0 : $errors) -} --=20 2.43.0 From nobody Sat Nov 15 05:39:10 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1755191756; cv=none; d=zohomail.com; s=zohoarc; b=OLUsyYULr4RzyYdrZj9J2Bo7AYQvtQmAyE7QTQq3qIavUPSgst17SqQQjnNiL8qE0muIAdnE+Kx8m8KxPHxpvJkJbhE4ocjUYFt5lI+CGTXSk2Ex1TVyLkzURqSnHhex8ZpRHSGJoY4BAlbrauhiJTb5CWzeHn2gxQkgTRcGsss= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1755191756; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=2uDCZPV6uMGt+mAe6STIf4qoEqC9ni2lBYY7D69qE04=; b=WhVEXA3U0+wVT7EcyEFWCgamoCwyCppoLDS3Mb4OUlTvcWAtxrvdfEsgxyhdtiIXixTqSihP894IzbJdiiWJ4bTvd7bm0UnRJDMcSlkH7z/s5b8heg9lj2DrB151Z2r4CcjvZnRV1Ogwqc1dI7q6YsTjY3wGWLBlOdVdzrZ9bbg= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1755191756444243.87425133903366; Thu, 14 Aug 2025 10:15:56 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1umbWI-0008Nr-I5; Thu, 14 Aug 2025 13:13:42 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1umbWG-0008NN-Rg for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:40 -0400 Received: from mail-wm1-x336.google.com ([2a00:1450:4864:20::336]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1umbWE-0001pt-0G for qemu-devel@nongnu.org; Thu, 14 Aug 2025 13:13:40 -0400 Received: by mail-wm1-x336.google.com with SMTP id 5b1f17b1804b1-45a1b00f187so5442085e9.0 for ; Thu, 14 Aug 2025 10:13:36 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [2001:8b0:1d0::2]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-45a1c76e9basm29489165e9.21.2025.08.14.10.13.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Aug 2025 10:13:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1755191615; x=1755796415; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=2uDCZPV6uMGt+mAe6STIf4qoEqC9ni2lBYY7D69qE04=; b=hDrkJKsvxc9b63AdrSMSmdu32VWxcpOB1hiCLhKJp2TfRKfyaN36OPDNcqGvMY8i2w VjXUROoxD0ih2QLyKbFutVqlygJDKZu7cB3++TbAVGXrDIZga10Fi56aGpyUrPQwoWmS BmeopEGkXxOxyKSxgJrRNU+WecZzxbrPsQqiQag+Iomt4aFsK4M0gjQrPYupnlSLkx1Y HM1TJ+4ndbCTi0nF9bUnsDSnai7NGOjsAAu/isdBFyvjSOI6R2t0wNRvbzZA9suUlhfu bBR9+N9jwovLS/aKoESSqIZeJr4w/melgfDNtr7ucgmFGInpgSk1vQYo0B9w3DUKSgLp szlA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1755191615; x=1755796415; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=2uDCZPV6uMGt+mAe6STIf4qoEqC9ni2lBYY7D69qE04=; b=HWTbdib3PZgS3IvbzWIdLQOUZ3Gx72MbE7QZpv996zsi6/a85fI8pnC4M7e0wlSEya 0frO/u3Ao3ulIaKwX7cQbmC16IS6JZxl3s3+VggnJTERNXr2FMcbJ5bOmRbzDT2N7RPo VVNoVHjjVBKFj+Ig+0isrbmlqstPxqpiBQL1Jq97jHWKYsVKgNn94bHPjt2aN5FI4TxN xTkQ7J9eB0wVhAEWk2nTi8YEfNndthmXqZWzMadYWyob3lzEMjdtvcIhGLnB/cFtz50G KnlJkugPnFZZFM1AC3xB2hsfCupy5OvO+RNCFzzQbKzruFAyjXluW2shvyWLfuuo9V+a 0uQw== X-Gm-Message-State: AOJu0YzOqXcxdCzLRSNenpI/Zbs0q78c1uUNjTP5z6qGKAHigSDSttrV 50Pj2IadhUihoJrFOQFUEllx8F2x7PUo8peXjbiZSzTnvE4RuJB3yd1/jQzMtsuX2oP/AZ5RY5B iLlNb X-Gm-Gg: ASbGncsIJID7wyZFBrOBdw7VROj09E5Gi7v9qiEwjPACKHIzBgd225dt5RPDsS+4CCV XYZPqG2nc2EhGMl4Y7g6A1TXIoRM5BTqzNK1ffVZl+7TYwHLb2m3YtuUXDXQwBcHdrEW0dA+7TM r55iNhQQyyrZdRLIh+yUuGf3LikD5Eyaspu90YzynQ0zBELH2ZHgUyAh5WMoHUiOKW4TdBqmbe9 Js984JDp02jmUjew+bON0i/lK0/F5UPVZLT9hqMCyNeSXWIagRSPwG1n2vAnxDRFGQsnLe0dkR2 dx6gY/c61+uLv5zx0SZYspZkXINMhUV5oksQfVxrD3puK5F+vFTjLfgo1pK7+EN6nSA9l55qLHq LeYGGXSv0gj9fDdX4v3yP2ESLGkwN X-Google-Smtp-Source: AGHT+IHm0KULiRwpido2Ihp6qyOc0zvX5kwY9AvE1FEpGnoC0tvUhB4NMhEz56MmyzUr7lKQB9HKoQ== X-Received: by 2002:a05:600c:1908:b0:459:e466:1bec with SMTP id 5b1f17b1804b1-45a1cc22d1emr26874415e9.2.1755191615047; Thu, 14 Aug 2025 10:13:35 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Cc: Paolo Bonzini , John Snow Subject: [PATCH for-10.2 8/8] MAINTAINERS: Put kernel-doc under the "docs build machinery" section Date: Thu, 14 Aug 2025 18:13:23 +0100 Message-ID: <20250814171324.1614516-9-peter.maydell@linaro.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250814171324.1614516-1-peter.maydell@linaro.org> References: <20250814171324.1614516-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::336; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x336.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1755191756832116601 Content-Type: text/plain; charset="utf-8" We never had a MAINTAINERS entry for the old kernel-doc script; add the files for the new Python kernel-doc under "Sphinx documentation configuration and build machinery", as the most appropriate subsection. Signed-off-by: Peter Maydell Reviewed-by: Mauro Carvalho Chehab Reviewed-by: Paolo Bonzini --- MAINTAINERS | 2 ++ 1 file changed, 2 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index a07086ed762..efa59ce7c36 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4436,6 +4436,8 @@ F: docs/sphinx/ F: docs/_templates/ F: docs/devel/docs.rst F: docs/devel/qapi-domain.rst +F: scripts/kernel-doc +F: scripts/lib/kdoc/ =20 Rust build system integration M: Manos Pitsidianakis --=20 2.43.0