[PATCH] drm/amdgpu/userq: fix user_queue parameters list

[PATCH] drm/amdgpu/userq: fix user_queue parameters list

[Bagas Sanjaya]

Sphinx reports htmldocs warning:

Documentation/gpu/amdgpu/module-parameters:7: drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c:1119: ERROR: Unexpected indentation. [docutils]

Fix the warning by using reST bullet list syntax for user_queue
parameter options, separated from preceding paragraph by a blank
line.

Fixes: fb20954c9717 ("drm/amdgpu/userq: rework driver parameter")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20250422202956.176fb590@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
index b9a1ef343c79cf..ec8057597c5aad 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
@@ -1115,11 +1115,12 @@ 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
+ * Enable user queues on systems that support user queues. Possible values:
+ *
+ * - -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);

base-commit: 127e612bf16726620e431b6e0f771424916492be
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] drm/amdgpu/userq: fix user_queue parameters list

[Alex Deucher]

Applied.  Thanks.

Alex

On Sat, Apr 26, 2025 at 10:37 PM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> Sphinx reports htmldocs warning:
>
> Documentation/gpu/amdgpu/module-parameters:7: drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c:1119: ERROR: Unexpected indentation. [docutils]
>
> Fix the warning by using reST bullet list syntax for user_queue
> parameter options, separated from preceding paragraph by a blank
> line.
>
> Fixes: fb20954c9717 ("drm/amdgpu/userq: rework driver parameter")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20250422202956.176fb590@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
> index b9a1ef343c79cf..ec8057597c5aad 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
> @@ -1115,11 +1115,12 @@ 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
> + * Enable user queues on systems that support user queues. Possible values:
> + *
> + * - -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);
>
> base-commit: 127e612bf16726620e431b6e0f771424916492be
> --
> An old man doll... just what I always wanted! - Clara
>