2023-07-27 03:29:26

by David Reaver

[permalink] [raw]
Subject: [PATCH] drm/i915/huc: fix intel_huc.c doc bulleted list format error

Fix the following make htmldocs errors/warnings:

./drivers/gpu/drm/i915/gt/uc/intel_huc.c:29: ERROR: Unexpected indentation.
./drivers/gpu/drm/i915/gt/uc/intel_huc.c:30: WARNING: Block quote ends without a blank line; unexpected unindent.
./drivers/gpu/drm/i915/gt/uc/intel_huc.c:35: WARNING: Bullet list ends without a blank line; unexpected unindent.

This output is a bit misleading. The real issue here is we need a blank
line before and after the bulleted list.

Link: https://www.kernel.org/doc/html/latest/gpu/i915.html#huc
Link: https://lore.kernel.org/dri-devel/[email protected]/

Signed-off-by: David Reaver <[email protected]>
---
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


2023-07-31 22:50:46

by Daniele Ceraolo Spurio

[permalink] [raw]
Subject: Re: [PATCH] drm/i915/huc: fix intel_huc.c doc bulleted list format error



On 7/26/2023 7:54 PM, David Reaver wrote:
> Fix the following make htmldocs errors/warnings:
>
> ./drivers/gpu/drm/i915/gt/uc/intel_huc.c:29: ERROR: Unexpected indentation.
> ./drivers/gpu/drm/i915/gt/uc/intel_huc.c:30: WARNING: Block quote ends without a blank line; unexpected unindent.
> ./drivers/gpu/drm/i915/gt/uc/intel_huc.c:35: WARNING: Bullet list ends without a blank line; unexpected unindent.
>
> This output is a bit misleading. The real issue here is we need a blank
> line before and after the bulleted list.
>
> Link: https://www.kernel.org/doc/html/latest/gpu/i915.html#huc
> Link: https://lore.kernel.org/dri-devel/[email protected]/
>
> Signed-off-by: David Reaver <[email protected]>

Reviewed-by: Daniele Ceraolo Spurio <[email protected]>

and pushed to drm-intel-gt-next.

thanks for the fix,
Daniele

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