[Intel-gfx] [PATCH 2/3] Documentation/gpu: Limit index to maxdepth=2

[Lucas De Marchi]

On Tue, Nov 15, 2022 at 03:18:01PM +0530, Balasubramani Vivekanandan wrote:
>On 07.11.2022 09:32, Lucas De Marchi wrote:
>> With a lot of sub-section it's a little bit hard to find the information
>> needed in the main GPU index. Limit the maxdepth to 2 so it doesn't get
>> poluted with noise from each driver and from other sections.
>>
>> Signed-off-by: Lucas De Marchi <lucas.demarchi at intel.com>
>> ---
>>  Documentation/gpu/index.rst | 1 +
>>  1 file changed, 1 insertion(+)
>>
>> diff --git a/Documentation/gpu/index.rst b/Documentation/gpu/index.rst
>> index b99dede9a5b1..1d9402d519be 100644
>> --- a/Documentation/gpu/index.rst
>> +++ b/Documentation/gpu/index.rst
>> @@ -3,6 +3,7 @@ Linux GPU Driver Developer's Guide
>>  ==================================
>>
>>  .. toctree::
>> +   :maxdepth: 2
>
>I have a bit different opinion here. I find it helpful to search for a
>topic if the headers remain uncollapsed.
>A top level view is anyways available in the TOC shown in the left side
>of the page which shows only the immediate next level headers.

I think the left side doesn't render very well. I'd still like to have
depth 2 for an overview, without going too deep in the innerworks of
each and every driver. Looking around I found there is a lot of use of
maxdepth in the indexes (git grep ":maxdepth:" -- Documentation), so
thought it would be something to adopt here.  Anyway, I don't mind
dropping these 2 patches if people don't agree with me :)


thanks
Lucas De Marchi