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

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] [day] [month] [year] [list]

Message-ID: <aA7KTVwwI3Wvz_JI@archie.me>
Date: Mon, 28 Apr 2025 07:22:37 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Ruben Wauters <rubenru09@....com>,
	Alex Deucher <alexander.deucher@....com>,
	Christian König <christian.koenig@....com>,
	David Airlie <airlied@...il.com>, Simona Vetter <simona@...ll.ch>
Cc: amd-gfx@...ts.freedesktop.org, dri-devel@...ts.freedesktop.org,
	linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] drm/amdgpu: fix unexpected indentation in docs

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@....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

Download attachment "signature.asc" of type "application/pgp-signature" (229 bytes)