* [PATCH] Documentation: driver-api: usb: Limit toctree depth
@ 2025-08-20 5:04 Bagas Sanjaya
2025-08-21 17:51 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Bagas Sanjaya @ 2025-08-20 5:04 UTC (permalink / raw)
To: Linux Kernel Mailing List, Linux Documentation, Linux USB
Cc: Greg Kroah-Hartman, Jonathan Corbet, Mauro Carvalho Chehab,
Bagas Sanjaya
toctree index in USB driver api docs currently spoils the entire docs
headings due to lack of :maxdepth: option. Add the option to limit
toctree depth to 1, mirroring usb subsystem docs in
Documentation/usb/index.rst.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/driver-api/usb/index.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/driver-api/usb/index.rst b/Documentation/driver-api/usb/index.rst
index cfa8797ea6144b..fcb24d0500d91d 100644
--- a/Documentation/driver-api/usb/index.rst
+++ b/Documentation/driver-api/usb/index.rst
@@ -3,6 +3,7 @@ Linux USB API
=============
.. toctree::
+ :maxdepth: 1
usb
gadget
base-commit: 37c52167b007d9d0bb8c5ed53dd6efc4969a1356
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] Documentation: driver-api: usb: Limit toctree depth
2025-08-20 5:04 [PATCH] Documentation: driver-api: usb: Limit toctree depth Bagas Sanjaya
@ 2025-08-21 17:51 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2025-08-21 17:51 UTC (permalink / raw)
To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation,
Linux USB
Cc: Greg Kroah-Hartman, Mauro Carvalho Chehab, Bagas Sanjaya
Bagas Sanjaya <bagasdotme@gmail.com> writes:
> toctree index in USB driver api docs currently spoils the entire docs
> headings due to lack of :maxdepth: option. Add the option to limit
> toctree depth to 1, mirroring usb subsystem docs in
> Documentation/usb/index.rst.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> Documentation/driver-api/usb/index.rst | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/driver-api/usb/index.rst b/Documentation/driver-api/usb/index.rst
> index cfa8797ea6144b..fcb24d0500d91d 100644
> --- a/Documentation/driver-api/usb/index.rst
> +++ b/Documentation/driver-api/usb/index.rst
> @@ -3,6 +3,7 @@ Linux USB API
> =============
>
> .. toctree::
> + :maxdepth: 1
>
It's still kind of a mess, but that does make it better. Applied,
thanks.
jon
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2025-08-21 17:51 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-08-20 5:04 [PATCH] Documentation: driver-api: usb: Limit toctree depth Bagas Sanjaya
2025-08-21 17:51 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).