Intel-XE Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: dri-devel@lists.freedesktop.org
Cc: "Randy Dunlap" <rdunlap@infradead.org>,
	"Matthew Brost" <matthew.brost@intel.com>,
	"Lucas De Marchi" <lucas.demarchi@intel.com>,
	"Thomas Hellström" <thomas.hellstrom@linux.intel.com>,
	"Rodrigo Vivi" <rodrigo.vivi@intel.com>,
	intel-xe@lists.freedesktop.org,
	"Maarten Lankhorst" <maarten.lankhorst@linux.intel.com>,
	"Maxime Ripard" <mripard@kernel.org>,
	"Thomas Zimmermann" <tzimmermann@suse.de>,
	"David Airlie" <airlied@gmail.com>,
	"Simona Vetter" <simona@ffwll.ch>
Subject: [PATCH] drm/xe: xe_guc_pc.c: fix DOC underlines
Date: Mon, 13 Oct 2025 11:28:26 -0700	[thread overview]
Message-ID: <20251013182827.733781-1-rdunlap@infradead.org> (raw)

Apparently a recent change in docutils has made checking of section
heading levels (underline style) be more careful.

There are 2 heading underline style errors reported here. Repair them by
changing the underline style from Chapter (using '=') to Section (using
'-') since they are used within a Chapter already (in xe_firmware.rst).

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

Frequency management:
=====================

Established title styles: =/= =

The parent of level 2 sections cannot be reached. The parser is at section level 2 but the current node has only 0 parent section(s).
One reason may be a high level section used in a directive that parses its content into a base node not attached to the document
(up to Docutils 0.21, these sections were silently dropped). [docutils]
Documentation/gpu/xe/xe_firmware:31: ../drivers/gpu/drm/xe/xe_guc_pc.c:86: ERROR: A level 2 section cannot be used here.

Render-C States:
================

Established title styles: =/= =

The parent of level 2 sections cannot be reached. The parser is at section level 2 but the current node has only 0 parent section(s).
One reason may be a high level section used in a directive that parses its content into a base node not attached to the document
(up to Docutils 0.21, these sections were silently dropped). [docutils]
"""

Fixes: dd08ebf6c352 ("drm/xe: Introduce a new DRM driver for Intel GPUs")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Sorry for the resend. I didn't have .gitconfig present so parts of
this didn't work as intended.

Cc: Matthew Brost <matthew.brost@intel.com>
Cc: Lucas De Marchi <lucas.demarchi@intel.com>
Cc: Thomas Hellström <thomas.hellstrom@linux.intel.com>
Cc: Rodrigo Vivi <rodrigo.vivi@intel.com>
Cc: intel-xe@lists.freedesktop.org
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: David Airlie <airlied@gmail.com>
Cc: Simona Vetter <simona@ffwll.ch>
---
 drivers/gpu/drm/xe/xe_guc_pc.c |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

--- linux-next-20251010.orig/drivers/gpu/drm/xe/xe_guc_pc.c
+++ linux-next-20251010/drivers/gpu/drm/xe/xe_guc_pc.c
@@ -74,8 +74,8 @@
  * connected power conservation features in the GuC firmware. The firmware
  * exposes a programming interface to the host for the control of SLPC.
  *
- * Frequency management:
- * =====================
+ * Frequency management
+ * --------------------
  *
  * Xe driver enables SLPC with all of its defaults features and frequency
  * selection, which varies per platform.
@@ -85,8 +85,8 @@
  * thus saving power. Base profile is default and ensures balanced performance
  * for any workload.
  *
- * Render-C States:
- * ================
+ * Render-C States
+ * ---------------
  *
  * Render-C states is also a GuC PC feature that is now enabled in Xe for
  * all platforms.

             reply	other threads:[~2025-10-13 18:28 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-13 18:28 Randy Dunlap [this message]
2025-10-13 19:59 ` [PATCH] drm/xe: xe_guc_pc.c: fix DOC underlines Rodrigo Vivi
2025-10-14  2:08   ` Randy Dunlap
2025-10-14  2:26     ` Randy Dunlap
2025-10-13 20:23 ` ✗ CI.checkpatch: warning for " Patchwork
2025-10-13 20:25 ` ✓ CI.KUnit: success " Patchwork
2025-10-13 21:24 ` ✓ Xe.CI.BAT: " Patchwork
2025-10-14  2:28 ` ✗ Xe.CI.Full: failure " Patchwork
2025-10-14  2:45 ` ✗ CI.checkpatch: warning for drm/xe: xe_guc_pc.c: fix DOC underlines (rev2) Patchwork
2025-10-14  2:47 ` ✓ CI.KUnit: success " Patchwork
2025-10-14  3:40 ` ✓ Xe.CI.BAT: " Patchwork
2025-10-14 11:30 ` ✓ Xe.CI.Full: " Patchwork

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251013182827.733781-1-rdunlap@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=airlied@gmail.com \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=intel-xe@lists.freedesktop.org \
    --cc=lucas.demarchi@intel.com \
    --cc=maarten.lankhorst@linux.intel.com \
    --cc=matthew.brost@intel.com \
    --cc=mripard@kernel.org \
    --cc=rodrigo.vivi@intel.com \
    --cc=simona@ffwll.ch \
    --cc=thomas.hellstrom@linux.intel.com \
    --cc=tzimmermann@suse.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox