Linux Documentation
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Jani Nikula <jani.nikula@intel.com>,
	dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH 1/3] Documentation/gpu: limit main toctree depth to 2
Date: Fri, 8 May 2026 11:37:09 -0700	[thread overview]
Message-ID: <8b9dc16b-ddb1-4da8-9c96-1f269b474cdc@infradead.org> (raw)
In-Reply-To: <cddd2d11c104132801510e3ab4e4b9ef3ea9cb6d.1778238671.git.jani.nikula@intel.com>



On 5/8/26 4:12 AM, Jani Nikula wrote:
> The main GPU documentation toctree has no limit to the toctree depth,
> which means the main GPU index page recursively includes all the
> headings in all of GPU documentation in the single table of
> contents. This makes getting any kind of overview of the documentation
> really difficult.
> 
> Limit the main toctree depth to 2 i.e. show at most two levels of
> headings.
> 
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

> ---
>  Documentation/gpu/index.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/gpu/index.rst b/Documentation/gpu/index.rst
> index 5d708a106b3f..65bf3b26e4f4 100644
> --- a/Documentation/gpu/index.rst
> +++ b/Documentation/gpu/index.rst
> @@ -3,6 +3,7 @@ GPU Driver Developer's Guide
>  ============================
>  
>  .. toctree::
> +   :maxdepth: 2
>  
>     introduction
>     drm-internals

-- 
~Randy

  reply	other threads:[~2026-05-08 18:37 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-08 11:12 [PATCH 0/3] Documentation/gpu: tables of contents cleanups and fixes Jani Nikula
2026-05-08 11:12 ` [PATCH 1/3] Documentation/gpu: limit main toctree depth to 2 Jani Nikula
2026-05-08 18:37   ` Randy Dunlap [this message]
2026-05-08 11:12 ` [PATCH 2/3] Documentation/gpu: add some tables of contents to large documents Jani Nikula
2026-05-08 18:37   ` Randy Dunlap
2026-05-08 11:12 ` [PATCH 3/3] Documentation/gpu/rfc: fix toctree Jani Nikula
2026-05-08 18:36   ` Randy Dunlap
2026-05-11  8:50 ` [PATCH 0/3] Documentation/gpu: tables of contents cleanups and fixes Jani Nikula
2026-05-11 12:14   ` 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=8b9dc16b-ddb1-4da8-9c96-1f269b474cdc@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=jani.nikula@intel.com \
    --cc=linux-doc@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