]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
drm/xe: Fix documentation heading levels in xe_guc_pc.c
authorSwaraj Gaikwad <swarajgaikwad1925@gmail.com>
Tue, 9 Dec 2025 09:48:36 +0000 (09:48 +0000)
committerRodrigo Vivi <rodrigo.vivi@intel.com>
Thu, 18 Dec 2025 22:56:39 +0000 (17:56 -0500)
commitc7b83a916d62c4d4447d7edf0bc5e06dc2afbdf8
treedfda5002ef4b3fa81baf1bfdaaef9f6ab3cb9e56
parentfb084e4183e1d79ead103265cafc4b6bc0ecba03
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>
drivers/gpu/drm/xe/xe_guc_pc.c