* [PATCH] memory: Remove kernel-doc comment marker
@ 2020-09-08 17:36 Eduardo Habkost
2020-09-08 18:17 ` Philippe Mathieu-Daudé
0 siblings, 1 reply; 2+ messages in thread
From: Eduardo Habkost @ 2020-09-08 17:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Peter Maydell
The IOMMUMemoryRegionClass struct documentation was never in the
kernel-doc format. Stop pretending it is, by removing the "/**"
comment marker.
This fixes a documentation build error introduced when we split
the IOMMUMemoryRegionClass typedef from the struct declaration.
Reported-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
I will submit a separate patch to convert the documentation to
kernel-doc format later. This is just a build fix that restores
the previous behavior (IOMMUMemoryRegionClass was never included
in the generated documentation).
---
Cc: Paolo Bonzini <pbonzini@redhat.com>
Cc: qemu-devel@nongnu.org
---
include/exec/memory.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/exec/memory.h b/include/exec/memory.h
index dc908738c6..f1bb2a7df5 100644
--- a/include/exec/memory.h
+++ b/include/exec/memory.h
@@ -211,7 +211,7 @@ enum IOMMUMemoryRegionAttr {
IOMMU_ATTR_SPAPR_TCE_FD
};
-/**
+/*
* IOMMUMemoryRegionClass:
*
* All IOMMU implementations need to subclass TYPE_IOMMU_MEMORY_REGION
--
2.26.2
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] memory: Remove kernel-doc comment marker
2020-09-08 17:36 [PATCH] memory: Remove kernel-doc comment marker Eduardo Habkost
@ 2020-09-08 18:17 ` Philippe Mathieu-Daudé
0 siblings, 0 replies; 2+ messages in thread
From: Philippe Mathieu-Daudé @ 2020-09-08 18:17 UTC (permalink / raw)
To: Eduardo Habkost, qemu-devel; +Cc: Paolo Bonzini, Peter Maydell
On 9/8/20 7:36 PM, Eduardo Habkost wrote:
> The IOMMUMemoryRegionClass struct documentation was never in the
> kernel-doc format. Stop pretending it is, by removing the "/**"
> comment marker.
>
> This fixes a documentation build error introduced when we split
> the IOMMUMemoryRegionClass typedef from the struct declaration.
>
> Reported-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> ---
> I will submit a separate patch to convert the documentation to
> kernel-doc format later. This is just a build fix that restores
> the previous behavior (IOMMUMemoryRegionClass was never included
> in the generated documentation).
> ---
> Cc: Paolo Bonzini <pbonzini@redhat.com>
> Cc: qemu-devel@nongnu.org
> ---
> include/exec/memory.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/exec/memory.h b/include/exec/memory.h
> index dc908738c6..f1bb2a7df5 100644
> --- a/include/exec/memory.h
> +++ b/include/exec/memory.h
> @@ -211,7 +211,7 @@ enum IOMMUMemoryRegionAttr {
> IOMMU_ATTR_SPAPR_TCE_FD
> };
>
> -/**
> +/*
> * IOMMUMemoryRegionClass:
> *
> * All IOMMU implementations need to subclass TYPE_IOMMU_MEMORY_REGION
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-09-08 18:18 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-09-08 17:36 [PATCH] memory: Remove kernel-doc comment marker Eduardo Habkost
2020-09-08 18:17 ` Philippe Mathieu-Daudé
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.