Re: [PATCH] gpu: drm: i915: fix documentation style
From: Ceraolo Spurio, Daniele
Date: Mon Aug 21 2023 - 17:00:51 EST
On 8/21/2023 9:22 AM, Jani Nikula wrote:
On Mon, 21 Aug 2023, "Ricardo B. Marliere" <rbmarliere@xxxxxxxxx> wrote:
This patch fixes the following sphinx warnings in the htmldocs make target:
Documentation/gpu/i915:546: ./drivers/gpu/drm/i915/gt/uc/intel_huc.c:29: ERROR: Unexpected indentation.
Documentation/gpu/i915:546: ./drivers/gpu/drm/i915/gt/uc/intel_huc.c:30: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/gpu/i915:546: ./drivers/gpu/drm/i915/gt/uc/intel_huc.c:35: WARNING: Bullet list ends without a blank line; unexpected unindent.
Signed-off-by: Ricardo B. Marliere <rbmarliere@xxxxxxxxx>
Already fixed by commit 175b036472f6 ("drm/i915: fix Sphinx indentation
warning") in drm-next.
Should we send this commit through the -fixes path, so it gets included
in 6.5?
Daniele
BR,
Jani.
---
drivers/gpu/drm/i915/gt/uc/intel_huc.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/drivers/gpu/drm/i915/gt/uc/intel_huc.c b/drivers/gpu/drm/i915/gt/uc/intel_huc.c
index ddd146265beb..fa70defcb5b2 100644
--- a/drivers/gpu/drm/i915/gt/uc/intel_huc.c
+++ b/drivers/gpu/drm/i915/gt/uc/intel_huc.c
@@ -26,6 +26,7 @@
* The kernel driver is only responsible for loading the HuC firmware and
* triggering its security authentication. This is done differently depending
* on the platform:
+ *
* - older platforms (from Gen9 to most Gen12s): the load is performed via DMA
* and the authentication via GuC
* - DG2: load and authentication are both performed via GSC.
@@ -33,6 +34,7 @@
* not-DG2 older platforms), while the authentication is done in 2-steps,
* a first auth for clear-media workloads via GuC and a second one for all
* workloads via GSC.
+ *
* On platforms where the GuC does the authentication, to correctly do so the
* HuC binary must be loaded before the GuC one.
* Loading the HuC is optional; however, not using the HuC might negatively