2023-11-06 20:18:18

by Hunter Chasens

[permalink] [raw]
Subject: [PATCH v2] drm: amd: Resolve Sphinx unexpected indentation warning

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, 7 insertions(+), 6 deletions(-)

diff --git a/drivers/gpu/drm/amd/pm/amdgpu_pm.c b/drivers/gpu/drm/amd/pm/amdgpu_pm.c
index 517b9fb4624c..81b8ceb26890 100644
--- a/drivers/gpu/drm/amd/pm/amdgpu_pm.c
+++ b/drivers/gpu/drm/amd/pm/amdgpu_pm.c
@@ -989,12 +989,13 @@ static ssize_t amdgpu_get_pp_features(struct device *dev,
* Reading back the files will show you the available power levels within
* 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
+ * E.g.::
+ *
+ * S: 19Mhz *
+ * 0: 615Mhz
+ * 1: 800Mhz
+ * 2: 888Mhz
+ * 3: 1000Mhz
*
*
* To manually adjust these states, first select manual using
--
2.39.3


2023-11-06 21:09:27

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH v2] drm: amd: Resolve Sphinx unexpected indentation warning



On 11/6/23 12:17, 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]>

Acked-by: Randy Dunlap <[email protected]>

Thanks.

> ---
> drivers/gpu/drm/amd/pm/amdgpu_pm.c | 13 +++++++------
> 1 file changed, 7 insertions(+), 6 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/pm/amdgpu_pm.c b/drivers/gpu/drm/amd/pm/amdgpu_pm.c
> index 517b9fb4624c..81b8ceb26890 100644
> --- a/drivers/gpu/drm/amd/pm/amdgpu_pm.c
> +++ b/drivers/gpu/drm/amd/pm/amdgpu_pm.c
> @@ -989,12 +989,13 @@ static ssize_t amdgpu_get_pp_features(struct device *dev,
> * Reading back the files will show you the available power levels within
> * 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
> + * E.g.::
> + *
> + * S: 19Mhz *
> + * 0: 615Mhz
> + * 1: 800Mhz
> + * 2: 888Mhz
> + * 3: 1000Mhz
> *
> *
> * To manually adjust these states, first select manual using

--
~Randy

2023-11-07 00:25:52

by Bagas Sanjaya

[permalink] [raw]
Subject: Re: [PATCH v2] drm: amd: Resolve Sphinx unexpected indentation warning

On Mon, Nov 06, 2023 at 03:17:39PM -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..81b8ceb26890 100644
> --- a/drivers/gpu/drm/amd/pm/amdgpu_pm.c
> +++ b/drivers/gpu/drm/amd/pm/amdgpu_pm.c
> @@ -989,12 +989,13 @@ static ssize_t amdgpu_get_pp_features(struct device *dev,
> * Reading back the files will show you the available power levels within
> * 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
> + * E.g.::
> + *
> + * S: 19Mhz *
> + * 0: 615Mhz
> + * 1: 800Mhz
> + * 2: 888Mhz
> + * 3: 1000Mhz
> *
> *
> * To manually adjust these states, first select manual using

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <[email protected]>

--
An old man doll... just what I always wanted! - Clara


Attachments:
(No filename) (1.01 kB)
signature.asc (235.00 B)
Download all attachments

2023-11-07 04:47:36

by Lazar, Lijo

[permalink] [raw]
Subject: Re: [PATCH v2] drm: amd: Resolve Sphinx unexpected indentation warning



On 11/7/2023 1:47 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]>
> ---
> drivers/gpu/drm/amd/pm/amdgpu_pm.c | 13 +++++++------
> 1 file changed, 7 insertions(+), 6 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/pm/amdgpu_pm.c b/drivers/gpu/drm/amd/pm/amdgpu_pm.c
> index 517b9fb4624c..81b8ceb26890 100644
> --- a/drivers/gpu/drm/amd/pm/amdgpu_pm.c
> +++ b/drivers/gpu/drm/amd/pm/amdgpu_pm.c
> @@ -989,12 +989,13 @@ static ssize_t amdgpu_get_pp_features(struct device *dev,
> * Reading back the files will show you the available power levels within
> * 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
> + * E.g.::

This will be like E.g.: Could you keep it like E.g.,<space>:: so that ::
is taken out?

Thanks,
Lijo

> + *
> + * S: 19Mhz *
> + * 0: 615Mhz
> + * 1: 800Mhz
> + * 2: 888Mhz
> + * 3: 1000Mhz
> *
> *
> * To manually adjust these states, first select manual using