Re: [PATCH v1] drm: amd: Resolve Sphinx unexpected indentation warning

From: Randy Dunlap
Date: Mon Nov 06 2023 - 00:26:37 EST




On 11/5/23 21:15, Bagas Sanjaya wrote:
> On Sun, Nov 05, 2023 at 04:00:44PM -0500, Hunter Chasens wrote:
>> diff --git a/drivers/gpu/drm/amd/pm/amdgpu_pm.c b/drivers/gpu/drm/amd/pm/amdgpu_pm.c
>> index 517b9fb4624c..703fe2542258 100644
>> --- a/drivers/gpu/drm/amd/pm/amdgpu_pm.c
>> +++ b/drivers/gpu/drm/amd/pm/amdgpu_pm.c
>> @@ -990,11 +990,14 @@ static ssize_t amdgpu_get_pp_features(struct device *dev,
>> * the power state and the clock information for those levels. If deep sleep is
>> * applied to a clock, the level will be denoted by a special level 'S:'
>> * E.g.,
>> - * S: 19Mhz *
>> - * 0: 615Mhz
>> - * 1: 800Mhz
>> - * 2: 888Mhz
>> - * 3: 1000Mhz
>> + *
>> + * ::
>> + *
>> + * S: 19Mhz *
>> + * 0: 615Mhz
>> + * 1: 800Mhz
>> + * 2: 888Mhz
>> + * 3: 1000Mhz
>> *
>> *
>> * To manually adjust these states, first select manual using
>
> LGTM, thanks!
>
> Fixes: 615585d09b33 ("Documentation/amdgpu: Modify pp_dpm_*clk details")
> Reviewed-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
>

but can it be done without being so obvious about using Sphinx (or is it ReST?)
in source files?

e.g.: (not tested)

* E.g.:
* * S: 19Mhz *
* * 0: 615Mhz
* * 1: 800Mhz
* * 2: 888Mhz
* * 3: 1000Mhz

This is what I have seen done in quite a few source files.

Oh well, lots of files are already infected, so WTH. :(

--
~Randy