mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>, Fei Li <fei1.li@intel.com>,
	acrn-dev@lists.projectacrn.org,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Subject: [PATCH] virt: acrn: fix kernel-doc in <uapi/linux/acrn.h>
Date: Thu, 23 Oct 2025 21:42:26 -0700	[thread overview]
Message-ID: <20251024044226.480531-1-rdunlap@infradead.org> (raw)

Fix the kernel-doc comments for struct acrn_mmiodev so that all
struct members are rendered correctly.
Correct io_base to io_addr in struct acrn_vdev.

acrn.h:441: warning: Function parameter or struct member 'res'
 not described in 'acrn_mmiodev'
acrn.h:479: warning: Function parameter or struct member 'io_addr'
 not described in 'acrn_vdev'
acrn.h:479: warning: Excess struct member 'io_base' description
 in 'acrn_vdev'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Fei Li <fei1.li@intel.com>
Cc: acrn-dev@lists.projectacrn.org
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
 include/uapi/linux/acrn.h |   11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

--- linux-next-20251022.orig/include/uapi/linux/acrn.h
+++ linux-next-20251022/include/uapi/linux/acrn.h
@@ -420,12 +420,13 @@ struct acrn_pcidev {
 /**
  * struct acrn_mmiodev - Info for assigning or de-assigning a MMIO device
  * @name:			Name of the MMIO device.
- * @res[].user_vm_pa:		Physical address of User VM of the MMIO region
+ * @res:			MMIO resource descriptor info.
+ * @res.user_vm_pa:		Physical address of User VM of the MMIO region
  *				for the MMIO device.
- * @res[].service_vm_pa:	Physical address of Service VM of the MMIO
+ * @res.service_vm_pa:		Physical address of Service VM of the MMIO
  *				region for the MMIO device.
- * @res[].size:			Size of the MMIO region for the MMIO device.
- * @res[].mem_type:		Memory type of the MMIO region for the MMIO
+ * @res.size:			Size of the MMIO region for the MMIO device.
+ * @res.mem_type:		Memory type of the MMIO region for the MMIO
  *				device.
  *
  * This structure will be passed to hypervisor directly.
@@ -449,7 +450,7 @@ struct acrn_mmiodev {
  * @id.fields.legacy_id:	ID of the virtual device if not a PCI device
  * @slot:			Virtual Bus/Device/Function of the virtual
  *				device
- * @io_base:			IO resource base address of the virtual device
+ * @io_addr:			IO resource base address of the virtual device
  * @io_size:			IO resource size of the virtual device
  * @args:			Arguments for the virtual device creation
  *

             reply	other threads:[~2025-10-24  4:42 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-24  4:42 Randy Dunlap [this message]
2025-10-24  6:00 ` Li, Fei1
2025-10-24  6:06   ` Randy Dunlap
2025-10-24  6:22     ` Li, Fei1
2025-10-24 19:44       ` Randy Dunlap
2025-10-27  5:54         ` Li, Fei1
2025-10-27  6:11           ` Randy Dunlap
2025-10-28  3:19             ` Fei Li
2025-10-28  3:45               ` Randy Dunlap
2025-10-28  4:36                 ` Fei Li

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251024044226.480531-1-rdunlap@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=acrn-dev@lists.projectacrn.org \
    --cc=fei1.li@intel.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®