Kees Cook <keescook@xxxxxxxxxxxx> writes: > On Thu, Sep 29, 2022 at 09:34:18AM -0600, Jonathan Corbet wrote: >> Jonathan Corbet <corbet@xxxxxxx> 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? The Rust documentation change to Documentation/index.rst is simple enough: > diff --git a/Documentation/index.rst b/Documentation/index.rst > index 4737c18c97ff..00722aa20cd7 100644 > --- a/Documentation/index.rst > +++ b/Documentation/index.rst > @@ -82,6 +82,7 @@ merged much easier. > maintainer/index > fault-injection/index > livepatch/index > + rust/index The resolution should take the docs-next version of the file, but add that line after "livepatch/index" in its new location. Thanks, jon
