Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) client-ip=23.128.96.38;
Message-ID: <ad4da3d6-c04a-4044-93ec-d5b59c35d7e1@oracle.com>
Date:   Tue, 24 Oct 2023 12:30:37 +0100
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH] include: uapi: linux: iommufd.h: fixed kernel-doc
 warnings
Content-Language: en-US
To:     Muhammad Muzammil <m.muzzammilashraf@gmail.com>, jgg@ziepe.ca,
        kevin.tian@intel.com
Cc:     iommu@lists.linux.dev, linux-kernel@vger.kernel.org
References: <20231023103852.28743-1-m.muzzammilashraf@gmail.com>
 <CAJHePoZzMagaTLdRqmisgKx5arvm_YujyefzeCku1=ETPHWLVw@mail.gmail.com>
From:   Joao Martins <joao.m.martins@oracle.com>
In-Reply-To: <CAJHePoZzMagaTLdRqmisgKx5arvm_YujyefzeCku1=ETPHWLVw@mail.gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?YmwxUFg4M0Z0bEJHZ0VicnBRbDRhY0htNVRPaC9xeVpuUW82dUZoUjZnSDhQ?=
 =?utf-8?B?VHVqb1FrL241bGdEcG5GZ3NtNTA4a1dETm8zR0hXYXhEVnlMZ1MzNnE3QUc5?=
 =?utf-8?B?NE1xQjRDYnBWRStMVENNSUJKWnVEL3kzU2tMcitvMnFuQlp4eFp2TWJVeTFV?=
 =?utf-8?B?a25LREV4K2RPRXA5S2ZaYTFnTjhsNzZZZzhjSG5mMzhaZk8zUTR2V1NzZjJ6?=
 =?utf-8?B?M29adzY0MmdiMnBURDcvYWJxY0dCT0c3WVl5bWlVcU1OZ01GWVc0MlRFaVYx?=
 =?utf-8?B?Wm1HWlVmR3ZvUU9BazR4RDB2WndPUC84KzNRL1JzcFkyTXNSMVRxa2haS2Ru?=
 =?utf-8?B?Szl5b1Z4aUNLejVCSVpBdC8rT0d2NW9zZzdtaVpzVGZtbi9wNTJxY05mZC9D?=
 =?utf-8?B?YTEyWlgwelZITDg1T05aS081V0FxcS91bFZndFlnMTdnQ1hsUFZ2Y2hPV1dI?=
 =?utf-8?B?cTlyTFU1eW4yb3k1ZjBML3BTR25LQjZQVXRLcGh6aDZEWTJFczBmRVBnK1Ns?=
 =?utf-8?B?L2h5MmJNaWF0TnZ3K2VUdnFBMWU5MStNSzVqZWlCdndCenFwNVNmb3A1L09G?=
 =?utf-8?B?ZStJblUvQXVmZ2xyZUJ6cWV3KzdicjVMenN2amlOMFR3cVJTekVnZzh5YXVF?=
 =?utf-8?B?aWNiTWl0TVZza1haQXI0RU51SzRWSTlwK3ZPZGlrbGtxNlFsdVMvQkRlM29T?=
 =?utf-8?B?WmMwWXE0T2ZvaEd6UlpIVFUzLytidkpyV3U4ZTJ2M0pqNWxha3hBTklBSGk0?=
 =?utf-8?B?SDFnbHN4cU9yU0JyOHFuYTJ5ZjZXUkRvN1hPOWNkcXppOWpHdDI4YVZCNEJG?=
 =?utf-8?B?RnhpNS9md2RiWFBidFdlQ2U0Uzl0b0pLUXJESkRyUURHajV0RUw5SjQ3Ylky?=
 =?utf-8?B?SU4rNG8zNS9DZ3V3SlBjZHV5YStIODRsMDJsaHQ1TFJUVWdndW53dTVYUDVa?=
 =?utf-8?B?di81TnJwajFTV3ZHczhNT3hNOFBjZS8vRCtFY1VaRjA4WjlRTjVXVUxZYUZJ?=
 =?utf-8?B?U1ZFS3ByMU1HSCtFUnEwVGhPWkc5Z1FnSHpPNWlvcFNsUStEZVlxRnNXSWRZ?=
 =?utf-8?B?STh0S2RZT2ZsR2xJbTE3cDZvSElKd0QyUGJvaWNuNkFVdWVkZnpEa2Q5RGN3?=
 =?utf-8?B?RE1URkRHZnhjQVhwZE52NklaRVNWUUQ2MlhOZ0M1aXZHME1rTlJNN3BDSFhS?=
 =?utf-8?B?VHpxVC9YeENweExZdkxUa3Y2eXdYNUJCR1o5Z3NJYUdORFhJNHhHVFpvK1Ew?=
 =?utf-8?B?eXJuRm1hZExFZHFERmxuNGMwRWlBM2R0VkRNSDFicExlMWVldi92L0dqTXdl?=
 =?utf-8?B?MHBaWE1qQ2kxakZhOXJjSUUyMnNabnpUbEM2STQ1N1I3S1FsRzN4elRaNHNx?=
 =?utf-8?B?cWtCQytYOVpVZU9JRUxkR3UxcW8rV1lzdDNkaDVBNk5jK1RkUGs1eTF0SlVP?=
 =?utf-8?B?aGZuSmdibW1yaUVLcG1uTXFtd3dLZVdKVTQrOHhrbk44ZHZvWi9DVFREc0l2?=
 =?utf-8?B?UENDL1N6QlFwUmZpaXdxdll1VDdRelNIa0VONkhFaEtmM0NRU0tKKzc5Q0VX?=
 =?utf-8?B?Z3ExQzloYnp4ejV0ZjBPWnJPRWQwTGJ1UkM3MUpKaWpPOEU1ZWEvN2l5UCtT?=
 =?utf-8?B?SlZsT1p0bk5CbmJKRlhUK1RMN1QxRHJ2bVpOUUY2WFkyUkZ5amE2VGtuMDUz?=
 =?utf-8?B?OHM2WG5rcXBIcEQxbHB5aG90LzNCbzhiS2dnRGEvUTVDbmw0OC9JK0JkYW9n?=
 =?utf-8?B?alJ1UjdiSmVjc1ZYYnZLWjZhaUwrK245QkJVTzVLQTdiK2E0aHdaUDU4d0c3?=
 =?utf-8?B?b0JYclBEbWQ2Wlo2TWlGS0hrTjdoQ3VMMkg2STZWczErZFpLTGg3YUxkSVVx?=
 =?utf-8?B?ZUNRaG4xVFN5VHZlRm1jOXRnbElMcW1WVWVZbngrZXpzWXpMSDF4dTFEQUY4?=
 =?utf-8?B?NnNPdjdpOTNVa1dVeGdCc2h4RVBEdG5FWkNzVUwwVVRQZGxkTnNVd2FicXd4?=
 =?utf-8?B?KzVldXpMaUJoQ3RsV1IvcEpoOWNsQ2o3TEs2VnZhbFJsRzJUMDVpWHN0dkNW?=
 =?utf-8?B?dzZVVFdzOGJvS01PY0hvbXpVQllMQVRoUE84b216dUFWTllpQ2JkN0N0ZHNG?=
 =?utf-8?B?NmM3bnloQ0RjY1EwWWs1ck9UZk0rWm5jVEpvQjZyY1Fka1Npb0VoM3N5MG56?=
 =?utf-8?B?ZkE9PQ==?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: QOylWYLucqg1k+mR5nkAWcvb7Dqsy2q9Qe83grnGGOrmRTtN8x3X/IaTGG34tmDkAv/qjmL+WNbPsjUsEnGCRIpfCY9oh0ZfKip2sFRsKSOPM+oeXvae5kF4gSvMl2GY3YYRvZ9cDU0lKZYAKR49jZE15y6nDJNwlaSYfu/DrFEkjnYb0HYknJagKa8+QJdwOWrd6DYNvHy7rEDqLr7iGG9Zaq6DdPAR64DjE0rox++PBOW3G31h1AoiTyMgeYF5e674GtFvt+pP41wtVUg7Xpr7CkiTSGHEKCfd8nCOWrD3dSQuMqWo9NrnIPlLuJ/b7aXtggxtOS3+nZqw4VC+ueB8ukQg7tzQ4MefZS7QhFBTZPksQDW09BXOXNXqrpHtQ3q2ADk0JAWfQbkvj4bO4TbEoksvgIK1MDiVpvyvt8a9A3/8eFWo0xOh2GSXrSHssg91cqGgqEXfg3jKiKbScgvwwG7ffR9/f3fdnXTguLh8IHjZ25n+aoRJP+z/fSE1Y2g7A0HYrrS9Jix+qideWUqn8b7pyTwkwCFecR+9qwKEplZ9+Ky2jjExnr3MrYcTQQZZ2bHd80AHOXuWNN3e9hbxksCMja6w6WOEMvnW7Yfk1OdN7WxEAPMI4TnlSnoquov6tsI4j5D0IjL2Ep+eqqVpm/wnPP1tvfdBlvl0eVUaBpZoVlk8DJll6jwWyPTCqw8hQWNbbeiW8dnsVQFTP2hdLtDztJoAZ8tZqQI4F0wKrUQ1e/qUlscwUBzgt/INugSxLueLdHX3vLcb6p+/ANFncxl1Glbpq3VzecX4GgcOo4yNj7U9zCGh3bNWNSCTkXTp2zEFSXRu1NjbjOqApOhB20LLnSlclOzjw1fIU26CB/fYStXmmL6IZkI568B9
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 75e6ae37-7892-4bf0-e8c4-08dbd484a7c8
X-MS-Exchange-CrossTenant-AuthSource: BLAPR10MB4835.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 Oct 2023 11:30:42.0805
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: RiwA9ZQWhhKgHdRx2h9FcFHhM6v+9KgZQvulRkncblUih5RfDOIVqQQ7ShvHt8H5vXDZf79ppVZiC6KgR59YWsXWqk5TYwcNtnPcoCTR95c=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN7PR10MB6980
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.272,Aquarius:18.0.980,Hydra:6.0.619,FMLib:17.11.176.26
 definitions=2023-10-24_11,2023-10-24_01,2023-05-22_02
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 spamscore=0 adultscore=0 phishscore=0
 mlxlogscore=999 mlxscore=0 bulkscore=0 suspectscore=0 malwarescore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2310170001
 definitions=main-2310240097
X-Proofpoint-ORIG-GUID: iNayav4BxDORrQkff6DGgzml_OkpatNG
X-Proofpoint-GUID: iNayav4BxDORrQkff6DGgzml_OkpatNG
X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no
	version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on fry.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (fry.vger.email [0.0.0.0]); Tue, 24 Oct 2023 04:31:06 -0700 (PDT)


On 24/10/2023 10:48, Muhammad Muzammil wrote:
> Hi all,
> 
> Can anyone review and approve this patch?
> 

The series that introduced the errors will have it fixed in next version -- I
had fixed it myself when it was reported to me by linux-next integration.

It should hit soon (few hours) in the list (in time for tomorrow's linux-next
build) fixed but fixed in the individual patches that introduced the issue.
There are a couple more changes involved in such version fixing other issues,
hence it took a day more that I originally intended.

Another contributor submitted similar thing:

[1]
https://lore.kernel.org/linux-iommu/20231023085552.5139-1-bragathemanick0908@gmail.com/

> On Mon, Oct 23, 2023 at 3:39 PM Muhammad Muzammil
> <m.muzzammilashraf@gmail.com> wrote:
>>
>> Fixed multiple kernel-docs warnings
>>
>> Signed-off-by: Muhammad Muzammil <m.muzzammilashraf@gmail.com>
>> ---
>>  include/uapi/linux/iommufd.h | 16 +++++++++-------
>>  1 file changed, 9 insertions(+), 7 deletions(-)
>>
>> diff --git a/include/uapi/linux/iommufd.h b/include/uapi/linux/iommufd.h
>> index 50f98f01fe10..2211f1b53d6e 100644
>> --- a/include/uapi/linux/iommufd.h
>> +++ b/include/uapi/linux/iommufd.h
>> @@ -419,7 +419,7 @@ enum iommu_hw_info_type {
>>  };
>>
>>  /**
>> - * enum iommufd_hw_info_capabilities
>> + * enum iommufd_hw_capabilities
>>   * @IOMMU_HW_CAP_DIRTY_TRACKING: IOMMU hardware support for dirty tracking
>>   *                               If available, it means the following APIs
>>   *                               are supported:
>> @@ -486,6 +486,7 @@ enum iommufd_hwpt_set_dirty_tracking_flags {
>>   * @size: sizeof(struct iommu_hwpt_set_dirty_tracking)
>>   * @flags: Combination of enum iommufd_hwpt_set_dirty_tracking_flags
>>   * @hwpt_id: HW pagetable ID that represents the IOMMU domain
>> + * @__reserved: Must be 0
>>   *
>>   * Toggle dirty tracking on an HW pagetable.
>>   */
>> @@ -499,12 +500,12 @@ struct iommu_hwpt_set_dirty_tracking {
>>                                           IOMMUFD_CMD_HWPT_SET_DIRTY_TRACKING)
>>
>>  /**
>> - * enum iommufd_get_dirty_bitmap_flags - Flags for getting dirty bits
>> - * @IOMMU_GET_DIRTY_BITMAP_NO_CLEAR: Just read the PTEs without clearing any
>> - *                                   dirty bits metadata. This flag can be
>> - *                                   passed in the expectation where the next
>> - *                                   operation is an unmap of the same IOVA
>> - *                                   range.
>> + * enum iommufd_hwpt_get_dirty_bitmap_flags - Flags for getting dirty bits
>> + * @IOMMU_HWPT_GET_DIRTY_BITMAP_NO_CLEAR: Just read the PTEs without clearing any
>> + *                                        dirty bits metadata. This flag can be
>> + *                                        passed in the expectation where the next
>> + *                                        operation is an unmap of the same IOVA
>> + *                                        range.
>>   *
>>   */
>>  enum iommufd_hwpt_get_dirty_bitmap_flags {
>> @@ -521,6 +522,7 @@ enum iommufd_hwpt_get_dirty_bitmap_flags {
>>   * @page_size: page size granularity of each bit in the bitmap
>>   * @data: bitmap where to set the dirty bits. The bitmap bits each
>>   *        represent a page_size which you deviate from an arbitrary iova.
>> + * @__reserved: Must be 0
>>   *
>>   * Checking a given IOVA is dirty:
>>   *
>> --
>> 2.27.0
>>
>