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

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]

Message-ID: <875y2f193t.fsf@intel.com>
Date:   Mon, 06 Nov 2023 12:15:02 +0200
From:   Jani Nikula <jani.nikula@...ux.intel.com>
To:     Bagas Sanjaya <bagasdotme@...il.com>,
        Randy Dunlap <rdunlap@...radead.org>,
        Hunter Chasens <hunter.chasens18@....edu>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Cc:     Lijo Lazar <lijo.lazar@....com>,
        Linux Documentation <linux-doc@...r.kernel.org>,
        Xinhui.Pan@....com, amd-gfx@...ts.freedesktop.org,
        Linux DRI Development <dri-devel@...ts.freedesktop.org>,
        alexander.deucher@....com, evan.quan@....com,
        christian.koenig@....com
Subject: Re: [PATCH v1] drm: amd: Resolve Sphinx unexpected indentation warning

On Mon, 06 Nov 2023, Bagas Sanjaya <bagasdotme@...il.com> wrote:
> On Sun, Nov 05, 2023 at 09:26:26PM -0800, Randy Dunlap wrote:
>> 
>> 
>> 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
>> >> + *
>> >> + * ::

The literal block marker :: could be added at the end of the preceding
paragraph, so it doesn't stand out so much. See [1].

BR,
Jani.

[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks

>> >> + *
>> >> + *  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@...il.com>
>> > 
>> 
>> but can it be done without being so obvious about using Sphinx (or is it ReST?)
>> in source files?
>
> Yes, the comment is included in Documentation/gpu/amdgpu/thermal.rst, so reST
> syntax applies there.

-- 
Jani Nikula, Intel