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;
Date:   Thu, 29 Sep 2022 08:59:26 -0700
From:   Kees Cook <keescook@chromium.org>
To:     Jonathan Corbet <corbet@lwn.net>
Cc:     linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
        Thorsten Leemhuis <linux@leemhuis.info>,
        Jani Nikula <jani.nikula@linux.intel.com>,
        Joe Perches <joe@perches.com>,
        David Vernet <void@manifault.com>,
        Miguel Ojeda <ojeda@kernel.org>
Subject: Re: [PATCH v3 0/7] Rewrite the top-level index.rst
Message-ID: <202209290858.4A3FC9082@keescook>
References: <20220927160559.97154-1-corbet@lwn.net>
 <87mtaii491.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <87mtaii491.fsf@meer.lwn.net>
Precedence: bulk

On Thu, Sep 29, 2022 at 09:34:18AM -0600, Jonathan Corbet wrote:
> Jonathan Corbet <corbet@lwn.net> writes:
> 
> > The top-level index.rst file is the entry point for the kernel's
> > documentation, especially for readers of the HTML output.  It is currently
> > a mess containing everything we thought to throw in there.  Firefox says it
> > would require 26 pages of paper to print it.  That is not a user-friendly
> > introduction.
> >
> > This series aims to improve our documentation entry point with a focus on
> > rewriting index.rst.  The result is, IMO, simpler and more approachable.
> > For anybody who wants to see the rendered results without building the
> > docs, have a look at:
> >
> >   https://static.lwn.net/kerneldoc/
> 
> So I think I'll go ahead and drop this into docs-next shortly.  Thanks
> to everybody who has commented.
> 
> This, of course, has the potential to create conflicts with other 6.1
> work that touches Documentation/index.rst.  Amazingly, as far as I can
> tell, there is only one linux-next commit touching that file - the
> addition of the Rust docs.  We'll want to be sure that doesn't get lost
> during the merge window.  I'll be sure to include a suitable heads-up in
> my pull request.

I can add a note in my PR of Rust too -- how should I suggest it be
resolved?

-- 
Kees Cook