linux-kernel - [PATCH 0/3] Generate documentation for error pointer functions

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20230509175543.2065835-1-james@equiv.tech>
Date:   Tue,  9 May 2023 10:55:41 -0700
From:   James Seo <james@...iv.tech>
To:     Jonathan Corbet <corbet@....net>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Andrew Morton <akpm@...ux-foundation.org>
Cc:     James Seo <james@...iv.tech>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: [PATCH 0/3] Generate documentation for error pointer functions

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