From patchwork Tue May 9 17:55:41 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: James Seo X-Patchwork-Id: 9101 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp3069326vqo; Tue, 9 May 2023 10:59:10 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ4YqzPDorKjUBZ7H014hC6L+RBuf2YEpqs2FpbnLImU9BiWwCyri+N2I55YZWdinLBSSKg+ X-Received: by 2002:a17:902:b189:b0:1a6:dc3b:9ed2 with SMTP id s9-20020a170902b18900b001a6dc3b9ed2mr14111992plr.13.1683655150349; Tue, 09 May 2023 10:59:10 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1683655150; cv=none; d=google.com; s=arc-20160816; b=JKfcelGeh6FL5bprjlzc27R5ylEBkI6MLqn25kXbOUH05aZoxjkEjnCVr6G5ssxaCs ebCk33gXSk5JEG0aHRYDN6sJsNqJXaQTmAn4mUGki2O3mzqVVZ349w6902wEFQMCbfaj KYM3mQ4uDa877vcpNNFs3YljB4ubw71ckvUhvoBfQ9JihdWn9y8RkbGdOWz4zdlgf+Z+ XKWnFBhQMssnMO9ZkfqBevJKwRQBpv1qQNBN7rBd8Ez/klg4y8eNR9QDToHjr0nb3Dlc /fdqsgx7+m1sBL3uz/QJY2Nnh1Xcg6LDITF5yhLhSSJl1XBkwMc8lwoY8qWU7b1TJEEw igVg== 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 :message-id:date:subject:cc:to:from:sender:dkim-signature; bh=H0s1EjZuxhXngjZYqwpGITBPMAphxWLlgrAxCrBbyGo=; b=TTb4+y5nlgy5sfXPO/LIXWsWYB11FnBfJ5MQUGp1eSFsasFeb5iaq1rRFQLws9Xb+B k/BrhsyY0Y0395p+WygeXkJFp0EppTbj4bbe/WMTju4do2C+BNbG5UltuK1vBHCNuLQR Wi4gsc5Enh8ge1WUttBbYNqIXdp9Z3qXrl6VEWsusS1L9p9IZkKzDpBX374yy6UZU6Wz pX4Ctx2yT/CwlEM9XpOYT6rE0rtOLmCkWQA4hZHMBwTvz1bgvm7OjYvpNraalYNZfpW9 Ofom72hxGS8SK8gXItlUsBhpg+kzD+k3RTy4NB2NQvabbw5nzWE++uX3OFu+ws6y58fm UFOg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@equiv.tech header.s=mx header.b=JJpzwpot; 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 u18-20020a170902e81200b001a51368b098si2150064plg.209.2023.05.09.10.58.55; Tue, 09 May 2023 10:59:10 -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=JJpzwpot; 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 S230060AbjEIR5e (ORCPT + 99 others); Tue, 9 May 2023 13:57:34 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56886 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229543AbjEIR5c (ORCPT ); Tue, 9 May 2023 13:57:32 -0400 Received: from m228-4.mailgun.net (m228-4.mailgun.net [159.135.228.4]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 70E5A40F4 for ; Tue, 9 May 2023 10:57:31 -0700 (PDT) DKIM-Signature: a=rsa-sha256; v=1; c=relaxed/relaxed; d=equiv.tech; q=dns/txt; s=mx; t=1683655050; x=1683662250; h=Content-Transfer-Encoding: MIME-Version: Message-Id: Date: Subject: Subject: Cc: To: To: From: From: Sender: Sender; bh=H0s1EjZuxhXngjZYqwpGITBPMAphxWLlgrAxCrBbyGo=; b=JJpzwpotyqD7HAot+RB44YbnoPidp4bgCUdzqMT+O4mf5OGzmE6L5eAUSAuckB40VUHwWKXp2Tc31aTQT7EOhkTSLgil4P0IlaIB3Db06Hq/QstEB6MMLbdTOKQf+Q3EvgW1iOaqlsM9KqHKBuQaClFbASUD/RkvFWfkTXarUF9EhnMZWM4RblErpTwVDVfW8/+GRfl9nfHWPUx3SYJ4Rr2skw3nZrhPkPuH8pUJcuLp22s6YzOIHrgu8et6Nn99SAVhxWIgeCCVem2Hv0NBc8YaVUUu1R3g+YrOps+EavPAywiBtHd4Xbxd4d0rEJjwTa/N3/4SBc060OYLOWqg8w== X-Mailgun-Sending-Ip: 159.135.228.4 X-Mailgun-Sid: WyI4ZWI3MiIsImxpbnV4LWtlcm5lbEB2Z2VyLmtlcm5lbC5vcmciLCI5M2Q1YWIiXQ== Received: from mail.equiv.tech (equiv.tech [142.93.28.83]) by 6da7de3861f4 with SMTP id 645a898a2eb1ecdcf6398bdb (version=TLS1.2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256); Tue, 09 May 2023 17:57:30 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 0/3] Generate documentation for error pointer functions Date: Tue, 9 May 2023 10:55:41 -0700 Message-Id: <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=ham 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?1765440382951850631?= X-GMAIL-MSGID: =?utf-8?q?1765440382951850631?= The error pointer functions are collectively mentioned hundreds of times in existing documentation (e.g. "Return: an ERR_PTR() on failure.", "If IS_ERR() is true, the function failed and PTR_ERR() gives you the error code.") This series adds kerneldocs for them and brings them into the docs build, immediately turning most such mentions into automatic cross-references. James Seo (3): Documentation: conf.py: Add __force to c_id_attributes err.h: Add missing kerneldocs for error pointer functions Documentation: core-api: Add error pointer functions to kernel-api Documentation/conf.py | 1 + Documentation/core-api/kernel-api.rst | 6 ++++ include/linux/err.h | 48 +++++++++++++++++++++++++++ 3 files changed, 55 insertions(+)