On Sun, Jul 20, 2025 at 3:03 PM Randy Dunlap <rdun...@infradead.org> wrote: > > + Bagas > > On 7/20/25 8:24 AM, Luis Felipe Hernandez wrote: > > Fix kernel-doc issues that reported Unexpected indentation errors > > durring documentation build (make htmldocs) in CAN, I3C and GPU drivers. > > > > 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) > > > > Link: > > https://lore.kernel.org/all/20250703023511.82768-1-luis.hernandez...@gmail.com/ > > > > Signed-off-by: Luis Felipe Hernandez <luis.hernandez...@gmail.com> > > --- > > drivers/gpu/drm/drm_gpuvm.c | 16 ++++++++-------- > > drm_gpuvm.c fixed by Bagas: > > > https://lore.kernel.org/linux-doc/20250709024501.9105-1-bagasdo...@gmail.com/ > > Otherwise LGTM. > > > drivers/i3c/device.c | 13 ++++++++----- > > i3c is also fixed by Bagas: > > https://lore.kernel.org/linux-i3c/20250702040424.18577-1-bagasdo...@gmail.com/ > > Otherwise LGTM. > > > drivers/net/can/ctucanfd/ctucanfd_base.c | 12 +++++++----- > > 3 files changed, 23 insertions(+), 18 deletions(-) > > > > > diff --git a/drivers/net/can/ctucanfd/ctucanfd_base.c > > b/drivers/net/can/ctucanfd/ctucanfd_base.c > > index bf6398772960..f910422188c3 100644 > > --- a/drivers/net/can/ctucanfd/ctucanfd_base.c > > +++ b/drivers/net/can/ctucanfd/ctucanfd_base.c > > @@ -506,11 +506,13 @@ static bool ctucan_is_txt_buf_writable(struct > > ctucan_priv *priv, u8 buf) > > * @buf: TXT Buffer index to which frame is inserted (0-based) > > * @isfdf: True - CAN FD Frame, False - CAN 2.0 Frame > > * > > - * Return: True - Frame inserted successfully > > - * False - Frame was not inserted due to one of: > > - * 1. TXT Buffer is not writable (it is in wrong state) > > - * 2. Invalid TXT buffer index > > - * 3. Invalid frame length > > + * Return: > > + * * True - Frame inserted successfully > > + * * False - Frame was not inserted due to one of: > > + * > > + * * TXT Buffer is not writable (it is in wrong state) > > + * * Invalid TXT buffer index > > + * * Invalid frame length > > */ > > static bool ctucan_insert_frame(struct ctucan_priv *priv, const struct > > canfd_frame *cf, u8 buf, > > bool isfdf) > > The numbered list is not a problem AFAIK. Did you see an issue with it? > And having the blank line just before the "False" list causing undesirable > html output: > > Return > > * True - Frame inserted successfully > > * False - Frame was not inserted due to one of: > > Description > > * TXT Buffer is not writable (it is in wrong state) > > * Invalid TXT buffer index > > * Invalid frame length > > The "Description" line should not be there. > > IMO all we want to do is convert the True and False lines into > a bulleted list and then the html output will look like this: > > Return > > * True - Frame inserted successfully > > * False - Frame was not inserted due to one of: > 1. TXT Buffer is not writable (it is in wrong state) > 2. Invalid TXT buffer index > 3. Invalid frame length > > > -- > ~Randy
Hi Randy, Thank you for the feedback, I apologize about the issues with this latest patch version: 1. I now see that Bagas has already fixed the GPU and I3C drivers... I apologize for the duplicate effort. 2. For the CAN driver, I understand your point about the blank line causing unwanted issues with the HTML. I'll correct this. 3. Re the numbered list> I was being overly broad in my conversion to bullet format. I will back this out. I'll send a v3 that focuses only on the CAN driver fix with the correct formatting you described (convert True/False to bullets while keeping the numbered sub list intact). Thank you for the guidance Best, Felipe
