* [PATCH 0/3] Documentation/gpu: reduce verbosity in toc
@ 2022-11-07 17:32 Lucas De Marchi
2022-11-07 17:32 ` [PATCH 1/3] Documentation/gpu: Fix section in the wrong scope Lucas De Marchi
` (2 more replies)
0 siblings, 3 replies; 8+ messages in thread
From: Lucas De Marchi @ 2022-11-07 17:32 UTC (permalink / raw)
To: dri-devel, intel-gfx, linux-doc
Cc: Tvrtko Ursulin, Mauro Carvalho Chehab, Lucas De Marchi
Checking some issues I was having i915 doc made me look at the toc for
Documentation/gpu. I think it's too hard to read when extending the toc
all levels for each driver. Reduce it to maxdepth=2.
Also fix the usage-stats section appearing in the wrong place.
Lucas De Marchi (3):
Documentation/gpu: Fix section in the wrong scope
Documentation/gpu: Limit index to maxdepth=2
Documentation/gpu: Limit drivers index to maxdepth=2
Documentation/gpu/drivers.rst | 1 +
Documentation/gpu/drm-usage-stats.rst | 1 -
Documentation/gpu/index.rst | 1 +
3 files changed, 2 insertions(+), 1 deletion(-)
--
2.38.1
^ permalink raw reply [flat|nested] 8+ messages in thread
* [PATCH 1/3] Documentation/gpu: Fix section in the wrong scope
2022-11-07 17:32 [PATCH 0/3] Documentation/gpu: reduce verbosity in toc Lucas De Marchi
@ 2022-11-07 17:32 ` Lucas De Marchi
2022-11-08 9:49 ` Tvrtko Ursulin
2022-11-07 17:32 ` [PATCH 2/3] Documentation/gpu: Limit index to maxdepth=2 Lucas De Marchi
2022-11-07 17:32 ` [PATCH 3/3] Documentation/gpu: Limit drivers " Lucas De Marchi
2 siblings, 1 reply; 8+ messages in thread
From: Lucas De Marchi @ 2022-11-07 17:32 UTC (permalink / raw)
To: dri-devel, intel-gfx, linux-doc
Cc: Tvrtko Ursulin, Mauro Carvalho Chehab, Lucas De Marchi
That section should still be inside "DRM client usage stats" rather than
as a sibling.
Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>
---
Documentation/gpu/drm-usage-stats.rst | 1 -
1 file changed, 1 deletion(-)
diff --git a/Documentation/gpu/drm-usage-stats.rst b/Documentation/gpu/drm-usage-stats.rst
index 92c5117368d7..b46327356e80 100644
--- a/Documentation/gpu/drm-usage-stats.rst
+++ b/Documentation/gpu/drm-usage-stats.rst
@@ -126,7 +126,6 @@ percentage utilization of the engine, whereas drm-engine-<str> only reflects
time active without considering what frequency the engine is operating as a
percentage of it's maximum frequency.
-===============================
Driver specific implementations
===============================
--
2.38.1
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [PATCH 2/3] Documentation/gpu: Limit index to maxdepth=2
2022-11-07 17:32 [PATCH 0/3] Documentation/gpu: reduce verbosity in toc Lucas De Marchi
2022-11-07 17:32 ` [PATCH 1/3] Documentation/gpu: Fix section in the wrong scope Lucas De Marchi
@ 2022-11-07 17:32 ` Lucas De Marchi
2022-11-15 9:48 ` [Intel-gfx] " Balasubramani Vivekanandan
2022-11-07 17:32 ` [PATCH 3/3] Documentation/gpu: Limit drivers " Lucas De Marchi
2 siblings, 1 reply; 8+ messages in thread
From: Lucas De Marchi @ 2022-11-07 17:32 UTC (permalink / raw)
To: dri-devel, intel-gfx, linux-doc
Cc: Tvrtko Ursulin, Mauro Carvalho Chehab, Lucas De Marchi
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@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
introduction
drm-internals
--
2.38.1
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [PATCH 3/3] Documentation/gpu: Limit drivers index to maxdepth=2
2022-11-07 17:32 [PATCH 0/3] Documentation/gpu: reduce verbosity in toc Lucas De Marchi
2022-11-07 17:32 ` [PATCH 1/3] Documentation/gpu: Fix section in the wrong scope Lucas De Marchi
2022-11-07 17:32 ` [PATCH 2/3] Documentation/gpu: Limit index to maxdepth=2 Lucas De Marchi
@ 2022-11-07 17:32 ` Lucas De Marchi
2 siblings, 0 replies; 8+ messages in thread
From: Lucas De Marchi @ 2022-11-07 17:32 UTC (permalink / raw)
To: dri-devel, intel-gfx, linux-doc
Cc: Tvrtko Ursulin, Mauro Carvalho Chehab, Lucas De Marchi
Just like the main index, the page generated is very verbose if all the
internal details of each driver is included.
Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>
---
Documentation/gpu/drivers.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/gpu/drivers.rst b/Documentation/gpu/drivers.rst
index 3a52f48215a3..a36ec133b123 100644
--- a/Documentation/gpu/drivers.rst
+++ b/Documentation/gpu/drivers.rst
@@ -3,6 +3,7 @@ GPU Driver Documentation
========================
.. toctree::
+ :maxdepth: 2
amdgpu/index
i915
--
2.38.1
^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH 1/3] Documentation/gpu: Fix section in the wrong scope
2022-11-07 17:32 ` [PATCH 1/3] Documentation/gpu: Fix section in the wrong scope Lucas De Marchi
@ 2022-11-08 9:49 ` Tvrtko Ursulin
2022-11-15 6:55 ` Lucas De Marchi
0 siblings, 1 reply; 8+ messages in thread
From: Tvrtko Ursulin @ 2022-11-08 9:49 UTC (permalink / raw)
To: Lucas De Marchi, dri-devel, intel-gfx, linux-doc; +Cc: Mauro Carvalho Chehab
On 07/11/2022 17:32, Lucas De Marchi wrote:
> That section should still be inside "DRM client usage stats" rather than
> as a sibling.
>
> Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>
> ---
> Documentation/gpu/drm-usage-stats.rst | 1 -
> 1 file changed, 1 deletion(-)
>
> diff --git a/Documentation/gpu/drm-usage-stats.rst b/Documentation/gpu/drm-usage-stats.rst
> index 92c5117368d7..b46327356e80 100644
> --- a/Documentation/gpu/drm-usage-stats.rst
> +++ b/Documentation/gpu/drm-usage-stats.rst
> @@ -126,7 +126,6 @@ percentage utilization of the engine, whereas drm-engine-<str> only reflects
> time active without considering what frequency the engine is operating as a
> percentage of it's maximum frequency.
>
> -===============================
> Driver specific implementations
> ===============================
>
Oops - yep.
Reviewed-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com>
Regards,
Tvrtko
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH 1/3] Documentation/gpu: Fix section in the wrong scope
2022-11-08 9:49 ` Tvrtko Ursulin
@ 2022-11-15 6:55 ` Lucas De Marchi
0 siblings, 0 replies; 8+ messages in thread
From: Lucas De Marchi @ 2022-11-15 6:55 UTC (permalink / raw)
To: Tvrtko Ursulin; +Cc: intel-gfx, Mauro Carvalho Chehab, dri-devel, linux-doc
On Tue, Nov 08, 2022 at 09:49:45AM +0000, Tvrtko Ursulin wrote:
>
>On 07/11/2022 17:32, Lucas De Marchi wrote:
>>That section should still be inside "DRM client usage stats" rather than
>>as a sibling.
>>
>>Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>
>>---
>> Documentation/gpu/drm-usage-stats.rst | 1 -
>> 1 file changed, 1 deletion(-)
>>
>>diff --git a/Documentation/gpu/drm-usage-stats.rst b/Documentation/gpu/drm-usage-stats.rst
>>index 92c5117368d7..b46327356e80 100644
>>--- a/Documentation/gpu/drm-usage-stats.rst
>>+++ b/Documentation/gpu/drm-usage-stats.rst
>>@@ -126,7 +126,6 @@ percentage utilization of the engine, whereas drm-engine-<str> only reflects
>> time active without considering what frequency the engine is operating as a
>> percentage of it's maximum frequency.
>>-===============================
>> Driver specific implementations
>> ===============================
>
>Oops - yep.
>
>Reviewed-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com>
thanks, applied this.
Anyone could take a look in the other 2?
thanks
Lucas De Marchi
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [Intel-gfx] [PATCH 2/3] Documentation/gpu: Limit index to maxdepth=2
2022-11-07 17:32 ` [PATCH 2/3] Documentation/gpu: Limit index to maxdepth=2 Lucas De Marchi
@ 2022-11-15 9:48 ` Balasubramani Vivekanandan
2022-11-15 17:36 ` Lucas De Marchi
0 siblings, 1 reply; 8+ messages in thread
From: Balasubramani Vivekanandan @ 2022-11-15 9:48 UTC (permalink / raw)
To: Lucas De Marchi, dri-devel, intel-gfx, linux-doc; +Cc: Mauro Carvalho Chehab
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@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.
Regards,
Bala
>
> introduction
> drm-internals
> --
> 2.38.1
>
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [Intel-gfx] [PATCH 2/3] Documentation/gpu: Limit index to maxdepth=2
2022-11-15 9:48 ` [Intel-gfx] " Balasubramani Vivekanandan
@ 2022-11-15 17:36 ` Lucas De Marchi
0 siblings, 0 replies; 8+ messages in thread
From: Lucas De Marchi @ 2022-11-15 17:36 UTC (permalink / raw)
To: Balasubramani Vivekanandan
Cc: intel-gfx, Mauro Carvalho Chehab, dri-devel, linux-doc
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@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
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2022-11-15 17:36 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-07 17:32 [PATCH 0/3] Documentation/gpu: reduce verbosity in toc Lucas De Marchi
2022-11-07 17:32 ` [PATCH 1/3] Documentation/gpu: Fix section in the wrong scope Lucas De Marchi
2022-11-08 9:49 ` Tvrtko Ursulin
2022-11-15 6:55 ` Lucas De Marchi
2022-11-07 17:32 ` [PATCH 2/3] Documentation/gpu: Limit index to maxdepth=2 Lucas De Marchi
2022-11-15 9:48 ` [Intel-gfx] " Balasubramani Vivekanandan
2022-11-15 17:36 ` Lucas De Marchi
2022-11-07 17:32 ` [PATCH 3/3] Documentation/gpu: Limit drivers " Lucas De Marchi
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).