From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A2FB2C77B7C for ; Tue, 9 May 2023 17:57:34 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229555AbjEIR5d (ORCPT ); Tue, 9 May 2023 13:57:33 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56888 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229491AbjEIR5c (ORCPT ); Tue, 9 May 2023 13:57:32 -0400 Received: from m228-13.mailgun.net (m228-13.mailgun.net [159.135.228.13]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 87D404480 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.13 X-Mailgun-Sid: WyIxNjU3YyIsImxpbnV4LWRvY0B2Z2VyLmtlcm5lbC5vcmciLCI5M2Q1YWIiXQ== Received: from mail.equiv.tech (equiv.tech [142.93.28.83]) by 6da7de3861f4 with SMTP id 645a898a2eb1ecdcf6398bda (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 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org 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(+) -- 2.34.1