From patchwork Tue May 9 17:55:43 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: James Seo X-Patchwork-Id: 91704 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp3069381vqo; Tue, 9 May 2023 10:59:17 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ78MkFf4tDoM2HaIdAFHEzSzRBhFNUpggua6Les+OulPUpP7DLT2hl1ulfAnE4pKuELR7Wr X-Received: by 2002:a17:902:e545:b0:1ac:544c:12f4 with SMTP id n5-20020a170902e54500b001ac544c12f4mr15333234plf.2.1683655157606; Tue, 09 May 2023 10:59:17 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1683655157; cv=none; d=google.com; s=arc-20160816; b=ln+XOH5v4L2yHXB79CBZUznKCUSTFNOyyBEBKXAowd8XOlzErw8GQ3eWf58uZGNM9O nQrJc17EWNL/votAyQXsQ+CKopmsjW5xbtPg6ZO8wRe3gaWmSJoEl6jGJdfzEFSmii2V Adgv9Ec6T3H8cOMFhc6obG+Qa0E8CXZ5vrp8aYDAq6bNTz5i9oDPA8415Tn1BNPwmVOm Cf4caHgP4+Ktz0wyaqVFWQYCn+OjWoozmnZm46/b+vDfyy5T6MYIeMVGoP0X5WVyUhZh hgcf/Or8EizQl3u8zh5wQcAbCxKbeZqUmMeP9XOnzNX1r1ZhvfZEq/L+Gx6jfdo6zX2i KZ+w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from:sender :dkim-signature; bh=6jttwz+Cugq4ceWJPmbhCtB6fO9JHbLfWVDtldhs2RI=; b=DiRcwmpZr/61b+CcNuE4ps2WC3teu7vRp0kEhbF9yhIPkONM/TdOcb23xeUchY19HZ k7/lIu5v2mgTcl+7d0hxZLYmymjCBn1e3rt1DXeVBF8AaEE6DyJWnBYj1n+eMOzWt/T2 DahjXHZt35akJik7zcd27h1jGgA7TUan5M+/vyhnI77g8ffOJHFYGnKuCllQkmcpP6si 6jz2ZtsB+TLcbwajTVgRxCmRPquZllWHEfT2voMk0HXbITdx1u3xFnE/85XpdsKDsr4S vIe0hXhWPd0jXg7bdBuY8K+6sgZ7BNCmu0vlydCw5pMHfGnScW+I0CFIfq+d9OB2ZTBM x6Sg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@equiv.tech header.s=mx header.b=X7u5t44Q; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=equiv.tech Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id jh19-20020a170903329300b0019ec2a633f4si1869517plb.505.2023.05.09.10.59.03; Tue, 09 May 2023 10:59:17 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@equiv.tech header.s=mx header.b=X7u5t44Q; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=equiv.tech Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233944AbjEIR5q (ORCPT + 99 others); Tue, 9 May 2023 13:57:46 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57146 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233992AbjEIR5n (ORCPT ); Tue, 9 May 2023 13:57:43 -0400 Received: from m228-4.mailgun.net (m228-4.mailgun.net [159.135.228.4]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0B1724EDD for ; Tue, 9 May 2023 10:57:41 -0700 (PDT) DKIM-Signature: a=rsa-sha256; v=1; c=relaxed/relaxed; d=equiv.tech; q=dns/txt; s=mx; t=1683655060; x=1683662260; h=Content-Transfer-Encoding: MIME-Version: References: In-Reply-To: Message-Id: Date: Subject: Subject: Cc: To: To: From: From: Sender: Sender; bh=6jttwz+Cugq4ceWJPmbhCtB6fO9JHbLfWVDtldhs2RI=; b=X7u5t44Q2a7RtJmVkklR1X/ulwhIPJYP6Bx1SJLNVEjmZgpAehFIqbRoLin1UK59t9r3dzHDXptVlwAQKPdmRb1rtkYNuGVKt4DhlV9WqbL2R3QlK6dOZ+qrlobd9+CgQDDNldn0aXNGdQrAdcN5p+8Qn/GbPq26GmsvHqyqKcC5aQ3UklB+tTr+3LqRzWBZZIkdJu5ceatCl2ZUPrsbKjFjMFGnHoPfc2lB0SDX7phDbTMI6zTKruh7HXUsR+GLQyqDJo/ZV0TvE+ONYlGAM3hIgQcNRQqNPJi2qgIzS6rBoTOWnCvXr5XD6HDejOXcURV7tKLxuR/YH2U4fttpFA== X-Mailgun-Sending-Ip: 159.135.228.4 X-Mailgun-Sid: WyI4ZWI3MiIsImxpbnV4LWtlcm5lbEB2Z2VyLmtlcm5lbC5vcmciLCI5M2Q1YWIiXQ== Received: from mail.equiv.tech (equiv.tech [142.93.28.83]) by c8d9e52701dd with SMTP id 645a8994dd415858cb50579b (version=TLS1.2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256); Tue, 09 May 2023 17:57:40 GMT Sender: james@equiv.tech From: James Seo To: Jonathan Corbet , Greg Kroah-Hartman , Andrew Morton Cc: James Seo , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 1/3] Documentation: conf.py: Add __force to c_id_attributes Date: Tue, 9 May 2023 10:55:43 -0700 Message-Id: <20230509175543.2065835-2-james@equiv.tech> In-Reply-To: <20230509175543.2065835-1-james@equiv.tech> References: <20230509175543.2065835-1-james@equiv.tech> MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1765440390398853785?= X-GMAIL-MSGID: =?utf-8?q?1765440390398853785?= Fixes the following error in the docs build that occurs with recent versions of Sphinx when parsing kerneldocs for a function with the '__force' macro in its signature: ./include/linux/err.h:51: WARNING: Error in declarator or parameters Error in declarator or parameters Invalid C declaration: Expected identifier, got keyword: void [error at 35] void * ERR_CAST (__force const void *ptr) -----------------------------------^ Currently, almost all of the few in-signature occurrences of '__force' are in the error pointer functions. Of those, ERR_CAST() is the only one with kerneldocs, but the kerneldocs aren't even being used to generate documentation. This change will allow all the error pointer functions to be properly documented. In addition to '__force', also defines '__nocast', '__safe', and '__private'. These are not currently used in any function signatures and do not need to be added to the docs config. Signed-off-by: James Seo --- Documentation/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/conf.py b/Documentation/conf.py index 37314afd1ac8..d4fdf6a3875a 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -74,6 +74,7 @@ if major >= 3: "__percpu", "__rcu", "__user", + "__force", # include/linux/compiler_attributes.h: "__alias",