From: Jonathan Corbet <corbet@lwn.net>
To: Costa Shulyupin <costa.shul@redhat.com>,
"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
open list <linux-kernel@vger.kernel.org>
Cc: Costa Shulyupin <costa.shul@redhat.com>
Subject: Re: [PATCH] docs: remove tree links from the main index
Date: Fri, 21 Jul 2023 13:55:57 -0600 [thread overview]
Message-ID: <87y1j9ca42.fsf@meer.lwn.net> (raw)
In-Reply-To: <20230718185156.1015753-1-costa.shul@redhat.com>
Costa Shulyupin <costa.shul@redhat.com> writes:
> and leave only their neighbor subsystem-apis
>
> because these links are already listed under
> section "Core subsystems" of Documentation/subsystem-apis.rst:
>
> Core subsystems
> ---------------
>
> .. toctree::
> :maxdepth: 1
>
> core-api/index
> driver-api/index
> mm/index
> power/index
> scheduler/index
> timers/index
> locking/index
>
> Reference:
> - https://www.kernel.org/doc/html/next/subsystem-apis.html#core-subsystems
>
> Motivation:
> - make the documentation more organized
> - increase consistency, observability and maintainability
> - improve balance of ToC tree by reducing overly populated lists
> - avoid duplicate parallel links
> - escape tangling of links
> - intention to fit the main index into one page
>
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
> ---
> Documentation/index.rst | 3 ---
> 1 file changed, 3 deletions(-)
>
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 9dfdc826618c..8d8b7eab1131 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -38,10 +38,7 @@ kernel.
> .. toctree::
> :maxdepth: 1
>
> - core-api/index
> - driver-api/index
> subsystem-apis
> - Locking in the kernel <locking/index>
So I don't really see the value of this. It takes away some of the most
important links from the documentation front page, leaving the "Internal
API manuals" section nearly empty. Why would we want to do this?
Thanks,
jon
next prev parent reply other threads:[~2023-07-21 19:56 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-18 18:51 [PATCH] docs: remove tree links from the main index Costa Shulyupin
2023-07-21 19:55 ` Jonathan Corbet [this message]
2023-07-22 2:21 ` Costa Shulyupin
2023-07-24 16:19 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87y1j9ca42.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=costa.shul@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox