mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Rosen Penev <rosenp@gmail.com>
To: linuxppc-dev@lists.ozlabs.org
Cc: linux-kernel@vger.kernel.org (open list)
Subject: [PATCH] macintosh: macio_asic: fix macio_add_one_device() kernel-doc
Date: Sun,  4 Oct 2026 16:40:25 -0700	[thread overview]
Message-ID: <20261004234025.524281-1-rosenp@gmail.com> (raw)

The kernel-doc comment for macio_add_one_device() does not describe
@parent and @parent_res or the return value, and describes @in_bay as
a flag although it is the media-bay device the new device sits in.

Document the missing parameters and the return value, and correct the
@in_bay description.

Assisted-by: LLM
Signed-off-by: Rosen Penev <rosenp@gmail.com>
---
 drivers/macintosh/macio_asic.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/drivers/macintosh/macio_asic.c b/drivers/macintosh/macio_asic.c
index ee3caa3d87d1..04fb0ffc2301 100644
--- a/drivers/macintosh/macio_asic.c
+++ b/drivers/macintosh/macio_asic.c
@@ -349,11 +349,15 @@ static void macio_setup_resources(struct macio_dev *dev,
 /**
  * macio_add_one_device - Add one device from OF node to the device tree
  * @chip: pointer to the macio_chip holding the device
+ * @parent: device to register the new device under
  * @np: pointer to the device node in the OF tree
- * @in_bay: set to 1 if device is part of a media-bay
+ * @in_bay: media-bay device this one sits in, or NULL
+ * @parent_res: resource to insert the device's resources under
  *
  * When media-bay is changed to hotswap drivers, this function will
  * be exposed to the bay driver some way...
+ *
+ * Return: the new macio_dev, or NULL on failure.
  */
 static struct macio_dev * macio_add_one_device(struct macio_chip *chip,
 					       struct device *parent,
-- 
2.56.0


                 reply	other threads:[~2026-10-04 23:40 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=20261004234025.524281-1-rosenp@gmail.com \
    --to=rosenp@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.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®