linux-kernel - Re: [PATCH] gpu: drm: i915: fix documentation style

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 21 Aug 2023 14:00:40 -0700
From:   "Ceraolo Spurio, Daniele" <daniele.ceraolospurio@...el.com>
To:     Jani Nikula <jani.nikula@...ux.intel.com>,
        "Ricardo B. Marliere" <rbmarliere@...il.com>,
        <joonas.lahtinen@...ux.intel.com>, <rodrigo.vivi@...el.com>,
        <tvrtko.ursulin@...ux.intel.com>, <airlied@...il.com>,
        <daniel@...ll.ch>, <John.C.Harrison@...el.com>,
        <alan.previn.teres.alexis@...el.com>,
        <harshit.m.mogalapalli@...cle.com>, <michal.wajdeczko@...el.com>,
        <gregkh@...uxfoundation.org>
CC:     <intel-gfx@...ts.freedesktop.org>,
        <dri-devel@...ts.freedesktop.org>, <linux-kernel@...r.kernel.org>,
        <skhan@...uxfoundation.org>
Subject: Re: [PATCH] gpu: drm: i915: fix documentation style



On 8/21/2023 9:22 AM, Jani Nikula wrote:
> On Mon, 21 Aug 2023, "Ricardo B. Marliere" <rbmarliere@...il.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@...il.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