github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-05-30 10:04:04 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

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

Browse Source 
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>
This commit is contained in:
Swaraj Gaikwad 2025-12-09 09:48:36 +00:00 committed by Rodrigo Vivi
parent fb084e4183
commit c7b83a916d
No known key found for this signature in database
GPG Key ID: FA625F640EEB13CA
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
drivers/gpu/drm/xe/xe_guc_pc.c
View File

@ -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.