linux-kernel - Re: [PATCH v2] Documentation: Document each netlink family

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

Message-ID: <20231117163939.2de33e83@kernel.org>
Date:   Fri, 17 Nov 2023 16:39:39 -0800
From:   Jakub Kicinski <kuba@...nel.org>
To:     leit@...a.com
Cc:     Jonathan Corbet <corbet@....net>, Breno Leitao <leitao@...ian.org>,
        netdev@...r.kernel.org, donald.hunter@...il.com,
        linux-doc@...r.kernel.org, pabeni@...hat.com, edumazet@...gle.com,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] Documentation: Document each netlink family

On Fri, 17 Nov 2023 15:17:02 -0700 Jonathan Corbet wrote:
> In principle I like this approach better.  There is one problem, though:
> 
> - In current kernels, on my machine, "make htmldocs" when nothing has
>   changed takes about 6s to complete.
> 
> - With this patch applied, it takes a little over 5 *minutes*.
> 
> Without having delved into it too far, I am guessing that the
> unconditional recreation of the netlink RST files is causing the rebuild
> of much of the documentation.  Even so, I don't quite get it.
> 
> That, clearly, would need to be fixed before this can go in.

FWIW on the C code-gen side we avoid touching the files if nothing
changed both at the Makefile level:

https://git.kernel.org/pub/scm/linux/kernel/git/netdev/net-next.git/tree/tools/net/ynl/generated/Makefile#n28

And the tool itself actually generates to a tempfile and compares
if the output changed:

https://git.kernel.org/pub/scm/linux/kernel/git/netdev/net-next.git/commit/?id=2b7ac0c87d985c92e519995853c52b9649ea4b07