linux-kernel - Re: [PATCH v2] virtio: Update kerneldoc in drivers/virtio/virtio_dma

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: <20250717092551456yMDDlrv0yFKFOsnqotOlG@zte.com.cn>
Date: Thu, 17 Jul 2025 09:25:51 +0800 (CST)
From: <jiang.peng9@....com.cn>
To: <mst@...hat.com>
Cc: <jasowang@...hat.com>, <krzk@...nel.org>, <xuanzhuo@...ux.alibaba.com>,
        <eperezma@...hat.com>, <sumit.semwal@...aro.org>,
        <christian.koenig@....com>, <virtualization@...ts.linux.dev>,
        <linux-kernel@...r.kernel.org>, <linux-media@...r.kernel.org>,
        <dri-devel@...ts.freedesktop.org>, <xu.xin16@....com.cn>,
        <yang.yang29@....com.cn>
Subject: Re: [PATCH v2] virtio: Update kerneldoc in drivers/virtio/virtio_dma_buf.c

> The extra documentation unfortunately just mechanically repeats what the
> code does. Code comments should explain the reasoning behind the code,
> instead.

Thanks for the helpful feedback - I appreciate you taking the time to review this.

In v3 I'll:

1.Remove the parentheses from function names to match virtio conventions;

2.Simplify all descriptions to focus on purpose rather than repeating code mechanics;

3.Consolidate return value documentation to essential information only.

The revised patch will maintain W=1 warning fixes while aligning with the kernel's documentation philosophy. I'll send the update shortly.

Best regards,
Peng Jiang