memory: Remove kernel-doc comment marker

[PATCH] memory: Remove kernel-doc comment marker

Eduardo Habkost posted 1 patch 3 years, 7 months ago

Download mbox

Test docker-quick@centos7 failed

Test docker-mingw@fedora failed

Test checkpatch failed

Test FreeBSD failed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20200908173650.3293057-1-ehabkost@redhat.com

Maintainers: Paolo Bonzini <pbonzini@redhat.com>

include/exec/memory.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

Expand all Fold all

[PATCH] memory: Remove kernel-doc comment marker

Posted by Eduardo Habkost 3 years, 7 months ago

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

Re: [PATCH] memory: Remove kernel-doc comment marker

Posted by Philippe Mathieu-Daudé 3 years, 7 months ago

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
>