Skip to content

Commit c7b83a9

Browse files
Swaraj-1925rodrigovivi
authored andcommitted
drm/xe: Fix documentation heading levels in xe_guc_pc.c
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> Link: https://patch.msgid.link/20251209094836.18589-1-swarajgaikwad1925@gmail.com Signed-off-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
1 parent fb084e4 commit c7b83a9

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

drivers/gpu/drm/xe/xe_guc_pc.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676
* exposes a programming interface to the host for the control of SLPC.
7777
*
7878
* Frequency management:
79-
* =====================
79+
* ---------------------
8080
*
8181
* Xe driver enables SLPC with all of its defaults features and frequency
8282
* selection, which varies per platform.
@@ -87,7 +87,7 @@
8787
* for any workload.
8888
*
8989
* Render-C States:
90-
* ================
90+
* ----------------
9191
*
9292
* Render-C states is also a GuC PC feature that is now enabled in Xe for
9393
* all platforms.

0 commit comments

Comments
 (0)