linux-kernel - [PATCH] docs: kernel_abi.py: add sphinx build dependencies

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

Message-Id: <5d7ea5b7cfbd9300fc6cc75900b1d8839abd4ba9.1648192982.git.mchehab@kernel.org>
Date:   Fri, 25 Mar 2022 08:23:18 +0100
From:   Mauro Carvalho Chehab <mchehab@...nel.org>
To:     Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Mauro Carvalho Chehab <mchehab@...nel.org>,
        "David E. Box" <david.e.box@...ux.intel.com>,
        "Hans de Goede" <hdegoede@...hat.com>,
        "Jonathan Corbet" <corbet@....net>,
        "Linux Kernel Mailing List" <linux-kernel@...r.kernel.org>,
        "Linux Next Mailing List" <linux-next@...r.kernel.org>,
        "Mark Gross" <markgross@...nel.org>,
        "Stephen Rothwell" <sfr@...b.auug.org.au>,
        Randy Dunlap <rdunlap@...radead.org>
Subject: [PATCH] docs: kernel_abi.py: add sphinx build dependencies

Ensure that Sphinx-build will handle the files parsed by
get_abi.pl as dependencies. This way, if they are touched,
the ABI output will be regenerated.

Reported-by: Hans de Goede <hdegoede@...hat.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@...nel.org>
---
 Documentation/sphinx/kernel_abi.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kernel_abi.py
index 4392b3cb4020..efab9b14a9f5 100644
--- a/Documentation/sphinx/kernel_abi.py
+++ b/Documentation/sphinx/kernel_abi.py
@@ -128,6 +128,7 @@ class KernelCmd(Directive):
         return out
 
     def nestedParse(self, lines, fname):
+        env = self.state.document.settings.env
         content = ViewList()
         node = nodes.section()
 
@@ -154,6 +155,9 @@ class KernelCmd(Directive):
                     self.do_parse(content, node)
                     content = ViewList()
 
+                    # Add the file to Sphinx build dependencies
+                    env.note_dependency(os.path.abspath(f))
+
                 f = new_f
 
                 # sphinx counts lines from 0
-- 
2.35.1