linux-kernel - [PATCH] Documentation/driver-api: Add hw-recoverable-errors to toctree

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>] [day] [month] [year] [list]

Message-Id: <20251127-vmcoreinfo_fix-v1-1-26f5b1c43da9@debian.org>
Date: Thu, 27 Nov 2025 07:34:24 -0800
From: Breno Leitao <leitao@...ian.org>
To: akpm@...ux-foundation.org, Jonathan Corbet <corbet@....net>, 
 Hanjun Guo <guohanjun@...wei.com>, 
 Andrew Morton <akpm@...ux-foundation.org>, 
 Shuai Xue <xueshuai@...ux.alibaba.com>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, 
 kernel-team@...a.com, Stephen Rothwell <sfr@...b.auug.org.au>, 
 Breno Leitao <leitao@...ian.org>
Subject: [PATCH] Documentation/driver-api: Add hw-recoverable-errors to
 toctree

Stephen reported that commit c03fb5253a0341e ("vmcoreinfo: track and log
recoverable hardware errors") started to warn about "document isn't
included in any toctree".

Fix it by adding the new rst in Subsystem-specific APIs section.

Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
Closes: https://lore.kernel.org/all/20250729150042.77832045@canb.auug.org.au/#t
Signed-off-by: Breno Leitao <leitao@...ian.org>
Fixes: c03fb5253a0341e ("vmcoreinfo: track and log recoverable hardware errors")
---
PS: This should probably go throught Andrew's tree as discussed in
https://lore.kernel.org/all/20251126084433.28bf7035fa56b11c5ee158d4@linux-foundation.org/
---
 Documentation/driver-api/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index baff96b5cf0b..1833e6a0687e 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -97,6 +97,7 @@ Subsystem-specific APIs
    gpio/index
    hsi
    hte/index
+   hw-recoverable-errors
    i2c
    iio/index
    infiniband

---
base-commit: 663d0d1af3faefe673cabf4b6b077149a87ad71f
change-id: 20251127-vmcoreinfo_fix-0aaee155c948

Best regards,
--  
Breno Leitao <leitao@...ian.org>