Bagas Sanjaya bagasdotme@gmail.com writes:
On Mon, Nov 07, 2022 at 08:48:57PM -0400, Jason Gunthorpe wrote:
From: Kevin Tian kevin.tian@intel.com
Add iommufd into the documentation tree, and supply initial documentation. Much of this is linked from code comments by kdoc.
The patch also exposes htmldocs warnings as Stephen Rothwell has reported on linux-next [1] due to the copyright comments mistaken for kernel-doc comments, so I have applied the fixup:
---- >8 ----
diff --git a/drivers/iommu/iommufd/device.c b/drivers/iommu/iommufd/device.c index 536a34d099968d..76b3761a89423e 100644 --- a/drivers/iommu/iommufd/device.c +++ b/drivers/iommu/iommufd/device.c @@ -1,5 +1,6 @@ // SPDX-License-Identifier: GPL-2.0-only -/* Copyright (c) 2021-2022, NVIDIA CORPORATION & AFFILIATES +/*
- Copyright (c) 2021-2022, NVIDIA CORPORATION & AFFILIATES
Um ... this makes no sense at all. If kernel-doc thought that was a kernel-doc comment, the problem is there, not here.
<looks>
So the report you're referring to is
https://lore.kernel.org/linux-next/20221110182938.40ce2651@canb.auug.org.au/
? If so, this change will not fix the problem. That error:
drivers/iommu/iommufd/device.c:1: warning: no structured comments found drivers/iommu/iommufd/main.c:1: warning: no structured comments found
is caused by using .. kernel-doc:: directives to extract documentation from files where none exists - thus "no structured comments found".
The *real* problem, methinks, is that the directives are added in patch 4 of the series, but the documentation doesn't show up until later. So the real fix would be to simply move this patch down. Or just not worry about it, since it all works out in the end and nobody will be bisecting a docs build.
Bagas, you are *again* misadvising people. Please stop doing that!
Thanks,
jon