* [PATCH] gpu: drm: i915: fix documentation style
@ 2023-08-21 15:02 Ricardo B. Marliere
2023-08-21 16:22 ` Jani Nikula
0 siblings, 1 reply; 4+ messages in thread
From: Ricardo B. Marliere @ 2023-08-21 15:02 UTC (permalink / raw)
To: jani.nikula, joonas.lahtinen, rodrigo.vivi, tvrtko.ursulin,
airlied, daniel, daniele.ceraolospurio, John.C.Harrison,
alan.previn.teres.alexis, harshit.m.mogalapalli, michal.wajdeczko,
gregkh
Cc: Ricardo B. Marliere, intel-gfx, dri-devel, linux-kernel, skhan
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@gmail.com>
---
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
--
2.40.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] gpu: drm: i915: fix documentation style
2023-08-21 15:02 [PATCH] gpu: drm: i915: fix documentation style Ricardo B. Marliere
@ 2023-08-21 16:22 ` Jani Nikula
2023-08-21 21:00 ` Ceraolo Spurio, Daniele
0 siblings, 1 reply; 4+ messages in thread
From: Jani Nikula @ 2023-08-21 16:22 UTC (permalink / raw)
To: Ricardo B. Marliere, joonas.lahtinen, rodrigo.vivi,
tvrtko.ursulin, airlied, daniel, daniele.ceraolospurio,
John.C.Harrison, alan.previn.teres.alexis, harshit.m.mogalapalli,
michal.wajdeczko, gregkh
Cc: Ricardo B. Marliere, intel-gfx, dri-devel, linux-kernel, skhan
On Mon, 21 Aug 2023, "Ricardo B. Marliere" <rbmarliere@gmail.com> 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@gmail.com>
Already fixed by commit 175b036472f6 ("drm/i915: fix Sphinx indentation
warning") in drm-next.
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
--
Jani Nikula, Intel Open Source Graphics Center
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] gpu: drm: i915: fix documentation style
2023-08-21 16:22 ` Jani Nikula
@ 2023-08-21 21:00 ` Ceraolo Spurio, Daniele
2023-08-22 21:50 ` Vivi, Rodrigo
0 siblings, 1 reply; 4+ messages in thread
From: Ceraolo Spurio, Daniele @ 2023-08-21 21:00 UTC (permalink / raw)
To: Jani Nikula, Ricardo B. Marliere, joonas.lahtinen, rodrigo.vivi,
tvrtko.ursulin, airlied, daniel, John.C.Harrison,
alan.previn.teres.alexis, harshit.m.mogalapalli, michal.wajdeczko,
gregkh
Cc: intel-gfx, dri-devel, linux-kernel, skhan
On 8/21/2023 9:22 AM, Jani Nikula wrote:
> On Mon, 21 Aug 2023, "Ricardo B. Marliere" <rbmarliere@gmail.com> 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@gmail.com>
> 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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] gpu: drm: i915: fix documentation style
2023-08-21 21:00 ` Ceraolo Spurio, Daniele
@ 2023-08-22 21:50 ` Vivi, Rodrigo
0 siblings, 0 replies; 4+ messages in thread
From: Vivi, Rodrigo @ 2023-08-22 21:50 UTC (permalink / raw)
To: harshit.m.mogalapalli@oracle.com, rbmarliere@gmail.com,
gregkh@linuxfoundation.org, joonas.lahtinen@linux.intel.com,
Harrison, John C, airlied@gmail.com,
tvrtko.ursulin@linux.intel.com, Ceraolo Spurio, Daniele,
daniel@ffwll.ch, jani.nikula@linux.intel.com, Wajdeczko, Michal,
Teres Alexis, Alan Previn
Cc: dri-devel@lists.freedesktop.org, intel-gfx@lists.freedesktop.org,
linux-kernel@vger.kernel.org, skhan@linuxfoundation.org
On Mon, 2023-08-21 at 14:00 -0700, Ceraolo Spurio, Daniele wrote:
>
>
> On 8/21/2023 9:22 AM, Jani Nikula wrote:
> > On Mon, 21 Aug 2023, "Ricardo B. Marliere" <rbmarliere@gmail.com>
> > 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@gmail.com>
> > 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?
175b036472f6 cherry-picked to drm-intel-fixes. Should be in this
week's pull request towards 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
>
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2023-08-22 21:50 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-08-21 15:02 [PATCH] gpu: drm: i915: fix documentation style Ricardo B. Marliere
2023-08-21 16:22 ` Jani Nikula
2023-08-21 21:00 ` Ceraolo Spurio, Daniele
2023-08-22 21:50 ` Vivi, Rodrigo
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox