[PATCH] drm/amdgpu: fix unexpected indentation in docs

[PATCH] drm/amdgpu: fix unexpected indentation in docs

[Ruben Wauters]

make htmldocs reports unexpected indentation on line 1119 in the kernel
doc comment. This was due to alignment of numbers (except the minus)
which caused indentation. This also had unintended effects on the
compiled documentation, with breaks and indentation after the -1 option.

This patch fixes the error, and changes the format of the options to be
more in line with others in the file, while still keeping it readable on
the code side.

Signed-off-by: Ruben Wauters <rubenru09@aol.com>
---
 drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
index b9a1ef343c79..6ddfd3ace2ba 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
@@ -1116,10 +1116,10 @@ module_param_named(rebar, amdgpu_rebar, int, 0444);
 /**
  * DOC: user_queue (int)
  * Enable user queues on systems that support user queues.
- * -1 = auto (ASIC specific default)
- *  0 = user queues disabled
- *  1 = user queues enabled and kernel queues enabled (if supported)
- *  2 = user queues enabled and kernel queues disabled
+ * (-1 = auto (ASIC specific default),
+ * 0 = user queues disabled,
+ * 1 = user queues enabled and kernel queues enabled (if supported),
+ * 2 = user queues enabled and kernel queues disabled)
  */
 MODULE_PARM_DESC(user_queue, "Enable user queues (-1 = auto (default), 0 = disable, 1 = enable, 2 = enable UQs and disable KQs)");
 module_param_named(user_queue, amdgpu_user_queue, int, 0444);
-- 
2.48.1

Re: [PATCH] drm/amdgpu: fix unexpected indentation in docs

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1932 bytes --]

On Mon, Apr 28, 2025 at 01:01:41AM +0100, Ruben Wauters wrote:
> make htmldocs reports unexpected indentation on line 1119 in the kernel
> doc comment. This was due to alignment of numbers (except the minus)
> which caused indentation. This also had unintended effects on the
> compiled documentation, with breaks and indentation after the -1 option.
> 
> This patch fixes the error, and changes the format of the options to be
> more in line with others in the file, while still keeping it readable on
> the code side.
> 
> Signed-off-by: Ruben Wauters <rubenru09@aol.com>
> ---
>  drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
> index b9a1ef343c79..6ddfd3ace2ba 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
> @@ -1116,10 +1116,10 @@ module_param_named(rebar, amdgpu_rebar, int, 0444);
>  /**
>   * DOC: user_queue (int)
>   * Enable user queues on systems that support user queues.
> - * -1 = auto (ASIC specific default)
> - *  0 = user queues disabled
> - *  1 = user queues enabled and kernel queues enabled (if supported)
> - *  2 = user queues enabled and kernel queues disabled
> + * (-1 = auto (ASIC specific default),
> + * 0 = user queues disabled,
> + * 1 = user queues enabled and kernel queues enabled (if supported),
> + * 2 = user queues enabled and kernel queues disabled)
>   */
>  MODULE_PARM_DESC(user_queue, "Enable user queues (-1 = auto (default), 0 = disable, 1 = enable, 2 = enable UQs and disable KQs)");
>  module_param_named(user_queue, amdgpu_user_queue, int, 0444);

Already addressed by [1]. Thanks!

[1]: https://lore.kernel.org/linux-doc/20250427023625.14327-2-bagasdotme@gmail.com/

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]