Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <f5830658-9cd7-4d44-6fd6-d031da1a3442@infradead.org>
Date:   Fri, 23 Sep 2022 12:02:02 -0700
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.2.2
Subject: Re: [PATCH v2 2/7] docs: Rewrite the front page
Content-Language: en-US
To:     Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
Cc:     linux-kernel@vger.kernel.org,
        Thorsten Leemhuis <linux@leemhuis.info>,
        Kees Cook <keescook@chromium.org>,
        Jani Nikula <jani.nikula@linux.intel.com>
References: <20220922204138.153146-1-corbet@lwn.net>
 <20220922204138.153146-3-corbet@lwn.net>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20220922204138.153146-3-corbet@lwn.net>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

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@lwn.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