Resolves Sphinx unexpected indentation warning when compiling
documentation (e.g. `make htmldocs`). Replaces tabs with spaces and adds
a literal block to keep vertical formatting of the
example power state list.
Signed-off-by: Hunter Chasens <[email protected]>
---
drivers/gpu/drm/amd/pm/amdgpu_pm.c | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
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
--
2.39.3
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 <[email protected]>
--
An old man doll... just what I always wanted! - Clara
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 <[email protected]>
>
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
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
> >> + *
> >> + * ::
> >> + *
> >> + * 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 <[email protected]>
> >
>
> 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.
--
An old man doll... just what I always wanted! - Clara
On Mon, 06 Nov 2023, Bagas Sanjaya <[email protected]> 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 <[email protected]>
>> >
>>
>> 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
On 11/6/2023 2:30 AM, Hunter Chasens wrote:
> Resolves Sphinx unexpected indentation warning when compiling
> documentation (e.g. `make htmldocs`). Replaces tabs with spaces and adds
> a literal block to keep vertical formatting of the
> example power state list.
>
> Signed-off-by: Hunter Chasens <[email protected]>
Thanks!
Reviewed-by: Lijo Lazar <[email protected]>
> ---
> drivers/gpu/drm/amd/pm/amdgpu_pm.c | 13 ++++++++-----
> 1 file changed, 8 insertions(+), 5 deletions(-)
>
> 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
First, apologies to Jani Nikula. I accedently top posted on the other thread.
My email client is giving me a hard time. The following works and, if
everyone agrees, I'll send out a v2.
* E.g.::
*
* S: 19Mhz *
* 0: 615Mhz
* 1: 800Mhz
* 2: 888Mhz
* 3: 1000Mhz
On 11/6/23 11:06, Hunter Chasens wrote:
> First, apologies to Jani Nikula. I accedently top posted on the other thread.
> My email client is giving me a hard time. The following works and, if
> everyone agrees, I'll send out a v2.
>
> * E.g.::
> *
> * S: 19Mhz *
> * 0: 615Mhz
> * 1: 800Mhz
> * 2: 888Mhz
> * 3: 1000Mhz
Please do.
Thanks.
--
~Randy