linux-kernel - Re: [PATCH v2 1/1] docs: Fix kernel-doc indentation errors

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: <CAGRSKZiZpHm1-EtMsdG5LMUKo6PRgamHpSsEcqDXvcc_PpR5Gw@mail.gmail.com>
Date: Mon, 21 Jul 2025 23:59:05 -0400
From: Felipe Hernandez <luis.hernandez093@...il.com>
To: Vincent Mailhol <mailhol.vincent@...adoo.fr>
Cc: Randy Dunlap <rdunlap@...radead.org>, Pavel Pisa <pisa@....felk.cvut.cz>, 
	Ondrej Ille <ondrej.ille@...il.com>, Frank Li <Frank.Li@....com>, 
	Maxime Ripard <mripard@...nel.org>, Thomas Zimmermann <tzimmermann@...e.de>, 
	David Airlie <airlied@...il.com>, Simona Vetter <simona@...ll.ch>, dri-devel@...ts.freedesktop.org, 
	linux-i3c@...ts.infradead.org, linux-can@...r.kernel.org, 
	linux-kernel@...r.kernel.org, 
	Alexandre Belloni <alexandre.belloni@...tlin.com>, Marc Kleine-Budde <mkl@...gutronix.de>, 
	Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>
Subject: Re: [PATCH v2 1/1] docs: Fix kernel-doc indentation errors

On Mon, Jul 21, 2025 at 3:48 AM Vincent Mailhol
<mailhol.vincent@...adoo.fr> wrote:
>
> On 21/07/2025 at 00:24, Luis Felipe Hernandez wrote:
> > Fix kernel-doc issues that reported Unexpected indentation errors
> > durring documentation build (make htmldocs) in CAN, I3C and GPU drivers.
>   ^^^^^^^
> during
>
> > Convert formatting to proper ReST list syntax to resolve warning.
> >
> > Changes since v1:
> > - Convert return value descriptions to proper ReST format
> > - Fix code block introduction with :: syntax
> > - Add GPU driver fixes
> > - Remove SCSI driver (already fixed)At
>
> The change log does not need to appear in the patch main body.
>
> Add a --- cutter after your signature and put the change log after that cutter.
> This way, the change log will automatically be discarded when the patch is picked.
>
> > Link: https://lore.kernel.org/all/20250703023511.82768-1-luis.hernandez093@gmail.com/
> >
> > Signed-off-by: Luis Felipe Hernandez <luis.hernandez093@...il.com>
> > ---
> >  drivers/gpu/drm/drm_gpuvm.c              | 16 ++++++++--------
> >  drivers/i3c/device.c                     | 13 ++++++++-----
> >  drivers/net/can/ctucanfd/ctucanfd_base.c | 12 +++++++-----
>
> Can you do one patch per sub-domains and send them separately? The maintainers
> of drivers/i3c/ are not the same as the maintainers of drivers/net/can/. And
> there is no dependencies preventing you to split.
>
>
> Yours sincerely,
> Vincent Mailhol
>

Hi Vincent,

Thank you for taking time to review my v2 patch and for the feedback.
I have since applied the changes you suggested. I apologize about
mixing the sub-domains, at first I thought they would all be related
as being part of the documentation subsystem since they were reporting
a similar error but I now understand these weren't documentation
related per-se and should've gone to each of the sub-domains
separately as the changes were made in the sources.

Again, I appreciate the guidance!

Best,

Felipe