[PATCH] drm/xe: Fix documentation heading levels in xe_guc_pc.c

[PATCH] drm/xe: Fix documentation heading levels in xe_guc_pc.c

[Swaraj Gaikwad]

Sphinx reports htmldocs warnings:

  Documentation/gpu/xe/xe_firmware:31: ./drivers/gpu/drm/xe/xe_guc_pc.c:76: ERROR: A level 2 section cannot be used here.
  Documentation/gpu/xe/xe_firmware:31: ./drivers/gpu/drm/xe/xe_guc_pc.c:87: ERROR: A level 2 section cannot be used here.

The xe_guc_pc.c documentation is included inside xe_firmware.rst.
The headers in the C file currently use '=' underlines, which conflict with
the parent document's section levels.

Fix this by demoting "Frequency management" and "Render-C States" headers
from '=' to '-' to correctly nest them as subsections.

Build environment: Python 3.13.7 Sphinx 8.2.3 docutils 0.22.3

Signed-off-by: Swaraj Gaikwad <swarajgaikwad1925@gmail.com>
---
 drivers/gpu/drm/xe/xe_guc_pc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/gpu/drm/xe/xe_guc_pc.c b/drivers/gpu/drm/xe/xe_guc_pc.c
index 951a49fb1d3e..a114f0d8592c 100644
--- a/drivers/gpu/drm/xe/xe_guc_pc.c
+++ b/drivers/gpu/drm/xe/xe_guc_pc.c
@@ -76,7 +76,7 @@
  * exposes a programming interface to the host for the control of SLPC.
  *
  * Frequency management:
- * =====================
+ * ---------------------
  *
  * Xe driver enables SLPC with all of its defaults features and frequency
  * selection, which varies per platform.
@@ -87,7 +87,7 @@
  * for any workload.
  *
  * Render-C States:
- * ================
+ * ----------------
  *
  * Render-C states is also a GuC PC feature that is now enabled in Xe for
  * all platforms.

base-commit: cfd4039213e7b5a828c5b78e1b5235cac91af53d
-- 
2.52.0

Re: [PATCH] drm/xe: Fix documentation heading levels in xe_guc_pc.c

[Swaraj Gaikwad]

Hi

I’m following up on this patch from last week. It addresses a couple of Sphinx
documentation errors ("A level 2 section cannot be used here") that occur
when building htmldocs.

Please let me know if the changes look good or if you would like me to
adjust anything.

Thanks,
Swaraj

Re: [PATCH] drm/xe: Fix documentation heading levels in xe_guc_pc.c

[Rodrigo Vivi]

On Thu, Dec 18, 2025 at 12:16:38PM +0530, Swaraj Gaikwad wrote:
> Hi
> 
> I’m following up on this patch from last week. It addresses a couple of Sphinx
> documentation errors ("A level 2 section cannot be used here") that occur
> when building htmldocs.
> 
> Please let me know if the changes look good or if you would like me to
> adjust anything.

Thanks for this patch. I just pushed to drm-xe-next.

> 
> Thanks,
> Swaraj