linux-kernel - Re: [PATCH v2 2/7] docs: Rewrite the front page

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]

Date:   Fri, 23 Sep 2022 12:02:02 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org,
        Thorsten Leemhuis <linux@...mhuis.info>,
        Kees Cook <keescook@...omium.org>,
        Jani Nikula <jani.nikula@...ux.intel.com>
Subject: Re: [PATCH v2 2/7] docs: Rewrite the front page

Hi Jonathan,

On 9/22/22 13:41, Jonathan Corbet wrote:
> The front page is the entry point to the documentation, especially for
> people who read it online.  It's a big mess of everything we could think to
> toss into it.  Rewrite the page with an eye toward simplicity and making it
> easy for readers to get going toward what they really want to find.
> 
> This is only a beginning, but it makes our docs more approachable than
> before.
> 
> Signed-off-by: Jonathan Corbet <corbet@....net>
> ---
>  Documentation/index.rst          | 150 +++++++++++--------------------
>  Documentation/subsystem-apis.rst |  58 ++++++++++++
>  2 files changed, 111 insertions(+), 97 deletions(-)
>  create mode 100644 Documentation/subsystem-apis.rst

I don't see a kernel version listed anywhere on the front page
(maybe it depends on what theme is used?) at
https://static.lwn.net/kerneldoc/, so I think it needs something like
this.

--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -18,6 +18,8 @@ documents into a coherent whole.  Please
 documentation are welcome; join the linux-doc list at vger.kernel.org if
 you want to help out.
 
+This documentation is for Linux kernel $(KERNELRELEASE).
+
 Licensing documentation
 -----------------------
 

The line numbering is probably off a bit, but the big problem is in
using $(KERNELRELEASE). Would using $(version) [with 'version' coming
from conf.py] work here? Nope, that doesn't work either.

-- 
~Randy