From: Jonathan Corbet <corbet@lwn.net>
To: Bagas Sanjaya <bagasdotme@gmail.com>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Linux USB <linux-usb@vger.kernel.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: Re: [PATCH] Documentation: driver-api: usb: Limit toctree depth
Date: Thu, 21 Aug 2025 11:51:22 -0600 [thread overview]
Message-ID: <87jz2w7ecl.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20250820050416.25219-1-bagasdotme@gmail.com>
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
prev parent reply other threads:[~2025-08-21 17:51 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-20 5:04 [PATCH] Documentation: driver-api: usb: Limit toctree depth Bagas Sanjaya
2025-08-21 17:51 ` Jonathan Corbet [this message]
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=87jz2w7ecl.fsf@trenco.lwn.net \
--to=corbet@lwn.net \
--cc=bagasdotme@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=mchehab+huawei@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