All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] KVM: arm64: pkvm: Drop keneldoc markers for the allocator structs
@ 2026-10-05  7:20 Vincent Donnefort
  2026-10-05  7:24 ` Vincent Donnefort
  2026-10-05  8:09 ` Marc Zyngier
  0 siblings, 2 replies; 3+ messages in thread
From: Vincent Donnefort @ 2026-10-05  7:20 UTC (permalink / raw)
  To: maz, oupton, kvmarm, linux-arm-kernel
  Cc: joey.gouly, seiden, suzuki.poulose, yuzenghui, catalin.marinas,
	will, kernel-team, fuad.tabba, Vincent Donnefort

chunk_hdr and hyp_allocator are private. Their description is not
exposed to the API documentation. Drop the kerneldoc markers.

While at it add the missing description for chunk_hdr::data.

Signed-off-by: Vincent Donnefort <vdonnefort@google.com>

diff --git a/arch/arm64/kvm/hyp/nvhe/alloc.c b/arch/arm64/kvm/hyp/nvhe/alloc.c
index c1881c0011c9..e1e6dd21cda1 100644
--- a/arch/arm64/kvm/hyp/nvhe/alloc.c
+++ b/arch/arm64/kvm/hyp/nvhe/alloc.c
@@ -28,13 +28,14 @@
  */
 #define MIN_ALLOC_SIZE 16UL
 
-/**
+/*
  * struct chunk_hdr - Chunk header
  * @next:       offset from this chunk header to the next one.
  * @prev:       offset from this chunk header to the previous one.
  * @__unmapped: Internal field containing the offset to the unmapped page
  *              boundary, multiplexed with the allocation state flag.
  * @hash:       Hash computed over the chunk header.
+ * @data:       Chunk payload.
  */
 struct chunk_hdr {
 	u32			next;
@@ -45,7 +46,7 @@ struct chunk_hdr {
 	char			data[];
 } __aligned(MIN_ALLOC_SIZE);
 
-/**
+/*
  * struct hyp_allocator - Heap allocator
  * @start:		Start in the allocator's reserved virtual address range.
  * @end:		End in the allocator's reserved virtual address range.

base-commit: f0406245cb9855e6318335a8a223551354291a46
-- 
2.56.0.rc1.315.gc6ed9934b7-goog


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] KVM: arm64: pkvm: Drop keneldoc markers for the allocator structs
  2026-10-05  7:20 [PATCH] KVM: arm64: pkvm: Drop keneldoc markers for the allocator structs Vincent Donnefort
@ 2026-10-05  7:24 ` Vincent Donnefort
  2026-10-05  8:09 ` Marc Zyngier
  1 sibling, 0 replies; 3+ messages in thread
From: Vincent Donnefort @ 2026-10-05  7:24 UTC (permalink / raw)
  To: maz, oupton, kvmarm, linux-arm-kernel
  Cc: joey.gouly, seiden, suzuki.poulose, yuzenghui, catalin.marinas,
	will, kernel-team, fuad.tabba

On Mon, Oct 05, 2026 at 08:20:46AM +0100, Vincent Donnefort wrote:
> chunk_hdr and hyp_allocator are private. Their description is not
> exposed to the API documentation. Drop the kerneldoc markers.
> 
> While at it add the missing description for chunk_hdr::data.
> 
> Signed-off-by: Vincent Donnefort <vdonnefort@google.com>

I forgot the relevant tags

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202610041002.Yvw5qUrt-lkp@intel.com/

> 
> diff --git a/arch/arm64/kvm/hyp/nvhe/alloc.c b/arch/arm64/kvm/hyp/nvhe/alloc.c
> index c1881c0011c9..e1e6dd21cda1 100644
> --- a/arch/arm64/kvm/hyp/nvhe/alloc.c
> +++ b/arch/arm64/kvm/hyp/nvhe/alloc.c
> @@ -28,13 +28,14 @@
>   */
>  #define MIN_ALLOC_SIZE 16UL
>  
> -/**
> +/*
>   * struct chunk_hdr - Chunk header
>   * @next:       offset from this chunk header to the next one.
>   * @prev:       offset from this chunk header to the previous one.
>   * @__unmapped: Internal field containing the offset to the unmapped page
>   *              boundary, multiplexed with the allocation state flag.
>   * @hash:       Hash computed over the chunk header.
> + * @data:       Chunk payload.
>   */
>  struct chunk_hdr {
>  	u32			next;
> @@ -45,7 +46,7 @@ struct chunk_hdr {
>  	char			data[];
>  } __aligned(MIN_ALLOC_SIZE);
>  
> -/**
> +/*
>   * struct hyp_allocator - Heap allocator
>   * @start:		Start in the allocator's reserved virtual address range.
>   * @end:		End in the allocator's reserved virtual address range.
> 
> base-commit: f0406245cb9855e6318335a8a223551354291a46
> -- 
> 2.56.0.rc1.315.gc6ed9934b7-goog
> 

-- 
Vincent

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] KVM: arm64: pkvm: Drop keneldoc markers for the allocator structs
  2026-10-05  7:20 [PATCH] KVM: arm64: pkvm: Drop keneldoc markers for the allocator structs Vincent Donnefort
  2026-10-05  7:24 ` Vincent Donnefort
@ 2026-10-05  8:09 ` Marc Zyngier
  1 sibling, 0 replies; 3+ messages in thread
From: Marc Zyngier @ 2026-10-05  8:09 UTC (permalink / raw)
  To: oupton, kvmarm, linux-arm-kernel, Vincent Donnefort
  Cc: joey.gouly, seiden, suzuki.poulose, yuzenghui, catalin.marinas,
	will, kernel-team, fuad.tabba

On Mon, 05 Oct 2026 08:20:46 +0100, Vincent Donnefort wrote:
> chunk_hdr and hyp_allocator are private. Their description is not
> exposed to the API documentation. Drop the kerneldoc markers.
> 
> While at it add the missing description for chunk_hdr::data.

Applied to next, thanks!

[1/1] KVM: arm64: pkvm: Drop keneldoc markers for the allocator structs
      commit: 6b1abd43b27a5ecac0672482dc8ca1e48c2c8d15

Cheers,

	M.
-- 
Without deviation from the norm, progress is not possible.



^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-10-05  8:09 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-10-05  7:20 [PATCH] KVM: arm64: pkvm: Drop keneldoc markers for the allocator structs Vincent Donnefort
2026-10-05  7:24 ` Vincent Donnefort
2026-10-05  8:09 ` Marc Zyngier

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.