All of lore.kernel.org
 help / color / mirror / Atom feed
From: Johan Hovold <johan@kernel.org>
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	"Rafael J. Wysocki" <rafael@kernel.org>,
	Danilo Krummrich <dakr@kernel.org>,
	Daniel Scally <djrscally@gmail.com>,
	Heikki Krogerus <heikki.krogerus@linux.intel.com>,
	Sakari Ailus <sakari.ailus@linux.intel.com>,
	Bartosz Golaszewski <brgl@kernel.org>,
	Andi Shyti <andi.shyti@kernel.org>,
	driver-core@lists.linux.dev, linux-acpi@vger.kernel.org,
	linux-i2c@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 3/8] swnode: fix device_add_of_node() kernel doc
Date: Mon, 16 Nov 2026 14:55:30 +0100	[thread overview]
Message-ID: <avsLUsKE333kAMiA@hovoldconsulting.com> (raw)
In-Reply-To: <avL5Mz5BiDRHUkMt@ashevche-desk.local>

On Tue, Nov 10, 2026 at 01:00:03PM +0200, Andy Shevchenko wrote:
> On Tue, Nov 10, 2026 at 09:51:19AM +0100, Johan Hovold wrote:
> > Software nodes added to a device by device_add_software_node() are
> > always secondary firmware nodes even if they may be stored in the
> > dev->fwnode pointer.
> > 
> > Fix the kernel doc which incorrectly claims that a software node added
> > using this interface "could become the primary node".
> > 
> > Also clarify that device_remove_software_node() should only be used to
> > remove software nodes added by device_add_software_node().
> 
> ...
> 
> >   * @dev: The device the software node is meant for.
> >   * @node: The software node.
> >   *
> > - * This function will make @node the secondary firmware node pointer of @dev. If
> > - * @dev has no primary node, then @node will become the primary node. The
> > - * function will register @node automatically if it wasn't already registered.
> > + * Register @node if it was not already registered and make it the secondary
> > + * firmware node of @dev.
> 
> While at it, please add a missing Return section (as kernel-doc complains about).

None of the swnode kernel-doc comments have a Return section so that is
better done separately for the whole file.

> >   */
> >  int device_add_software_node(struct device *dev, const struct software_node *node)
> >  {

Johan

  reply	other threads:[~2026-11-16 13:55 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-10  8:51 [PATCH v2 0/8] driver core: platform: fix swnode use-after-free on device release Johan Hovold
2026-11-10  8:51 ` [PATCH v2 1/8] " Johan Hovold
2026-11-13 17:23   ` Rafael J. Wysocki (Intel)
2026-11-10  8:51 ` [PATCH v2 2/8] i2c: core: fix swnode use-after-free on client deregistration Johan Hovold
2026-11-10 10:58   ` Andy Shevchenko
2026-11-10 11:15     ` Johan Hovold
2026-11-13 22:04   ` Wolfram Sang
2026-11-10  8:51 ` [PATCH v2 3/8] swnode: fix device_add_of_node() kernel doc Johan Hovold
2026-11-10 10:42   ` Johan Hovold
2026-11-10 11:00   ` Andy Shevchenko
2026-11-16 13:55     ` Johan Hovold [this message]
2026-11-10  8:51 ` [PATCH v2 4/8] swnode: ignore primary nodes in device_remove_software_node() Johan Hovold
2026-11-10 11:05   ` Andy Shevchenko
2026-11-13 17:29   ` Rafael J. Wysocki (Intel)
2026-11-16 14:05     ` Johan Hovold
2026-11-13 22:05   ` Wolfram Sang
2026-11-10  8:51 ` [PATCH v2 5/8] driver core: platform: warn on bad fwnode assignment Johan Hovold
2026-11-10 10:47   ` Johan Hovold
2026-11-10  8:51 ` [PATCH v2 6/8] driver core: platform: tests: fix swnode reuse test description Johan Hovold
2026-11-13 17:32   ` Rafael J. Wysocki (Intel)
2026-11-10  8:51 ` [PATCH v2 7/8] swnode: fix software_node_notify() primary node comment Johan Hovold
2026-11-10  8:51 ` [PATCH v2 8/8] device property: fix fwnode_get_next_child_node() comments Johan Hovold
2026-11-13 17:49   ` Rafael J. Wysocki (Intel)
2026-11-16 14:54     ` Johan Hovold
2026-11-16 15:22       ` Rafael J. Wysocki (Intel)

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=avsLUsKE333kAMiA@hovoldconsulting.com \
    --to=johan@kernel.org \
    --cc=andi.shyti@kernel.org \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=brgl@kernel.org \
    --cc=dakr@kernel.org \
    --cc=djrscally@gmail.com \
    --cc=driver-core@lists.linux.dev \
    --cc=gregkh@linuxfoundation.org \
    --cc=heikki.krogerus@linux.intel.com \
    --cc=linux-acpi@vger.kernel.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rafael@kernel.org \
    --cc=sakari.ailus@linux.intel.com \
    /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 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.