[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] xen/iocap.h: add documentation
- To: Jan Beulich <jbeulich@xxxxxxxx>, Grygorii Strashko <gragst.linux@xxxxxxxxx>
- From: Grygorii Strashko <grygorii_strashko@xxxxxxxx>
- Date: Tue, 11 Mar 2025 18:11:10 +0200
- Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=epam.com; dmarc=pass action=none header.from=epam.com; dkim=pass header.d=epam.com; arc=none
- Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=H/Rpomn/r+Ds019ajq2ernrgn2VW5Z5LjCdgBh5Xzu8=; b=hgSoWxSm5hTRD7MLHSPYH99lRwzIc5ZTqkpJBCMigdGMR+DIbUUAgPdwhjnA3iP+Z3VD+tqCsx6tWA3dnpYqZXJy/g9Lu7Xe4Gxq6izK0hC4f9FrbzTz/lIrjZMBZH7V/KvsRvhA5vS1T21QxkenCqMfpwRL9XRwdhZADv2f9oqZ5vOXsgSrHR4jE06cy737nhNhVSZUnnp7dwKjaowrkGe9kcxD0QWxSZfUy/beodldCZoxiSm28R1ZyOtjejGOQM7upatbh7bXAw824utQXin+sH9UHE4icqU8UpJBQKZ7qcEiVLDeYPlEAmCsw6uSiFHx2Ruvb//GkQq1ta/BTQ==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=WgRUhXU2T6P6C6sHx70BBwdjBPUrH+TNAaCM+izVP2wuiL9iw2dXmFKS4waJsubT1yb8XY9GDW3ZVuDjcTm9FGFTBi9fPvlzhznkv8hUX9ttZV1NPDxVGyu3B4qARkCw04XZTxEGUZxAjvts4rzdqZwWYXdnETOewvR/Si2vnMAmJAjIiP1yQFVP+/ZEFJcG8GFYXYD6sDD8eJbWThpRusHwh2xvNo3VJdO276GEAOgS8zLqS/px37ZYxVTuCDEgzt/RrIkn9T6cXDJp/NaO0/Ii/NMC3MrzadSaEIQ/lYmNZKnfYJrBfy78UUOOclb6VxUIPeYJ8ni/TAr2l+j+7A==
- Authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=epam.com;
- Cc: Stefano Stabellini <sstabellini@xxxxxxxxxx>, Julien Grall <julien@xxxxxxx>, Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, Michal Orzel <michal.orzel@xxxxxxx>, Roger Pau Monne <roger.pau@xxxxxxxxxx>, Anthony PERARD <anthony.perard@xxxxxxxxxx>, xen-devel@xxxxxxxxxxxxxxxxxxxx
- Delivery-date: Tue, 11 Mar 2025 16:11:22 +0000
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
Hi Jan,
On 11.03.25 17:35, Jan Beulich wrote:
On 11.03.2025 15:53, Grygorii Strashko wrote:
On 05.03.25 12:37, Jan Beulich wrote:
On 24.02.2025 12:38, Grygorii Strashko wrote:
Change rangeset parameters to "start, last" as proposed in [1],
and add documentation for public interface.
No functional changes.
[1] https://patchwork.kernel.org/comment/26251962/
Signed-off-by: Grygorii Strashko <grygorii_strashko@xxxxxxxx>
To be honest, this is getting too verbose for my taste. I also don't think
title and description fit together: One says the main thing the patch does
is add doc, the other says the main thing is the parameter renaming. When
then there's at least one further parameter which is also renamed, despite
not fitting the description.
I can update subject and commit message and resend.
This would address the latter part of my comment, but ...
Or you want me to drop some parts?
... only this would address the former part.
I'm very sorry, but I feel very much confused about your above comment :(
So I'd be appreciated if You can provide some clarification here.
1) you do not want API documentation at all?
2) you want API documentation, but only for some API?
3) you are not satisfied with documentation style?
In case 3, how do you want it to be look like? Could you point on any .h or
function in Xen,
to inherit the doc style?
Here I've followed doxygen style (like in xen/include/xen/vmap.h for example)
Before proceeding I've checked CODING_STYLE and other headers as well and saw
that
there is no generic style for code documentation.
Best regards,
-grygorii
|
