[PATCH v2 05/16] property: Move Return: section of fwnode_graph_get_endpoint_by_id() down

Sakari Ailus posted 16 patches 1 week ago
[PATCH v2 05/16] property: Move Return: section of fwnode_graph_get_endpoint_by_id() down
Posted by Sakari Ailus 1 week ago
Move Return: section of fwnode_graph_get_endpoint_by_id() down where it
habitually is located.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 drivers/base/property.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/base/property.c b/drivers/base/property.c
index f626d5bbe806..b52f7b3bbf84 100644
--- a/drivers/base/property.c
+++ b/drivers/base/property.c
@@ -1235,15 +1235,15 @@ static bool fwnode_graph_remote_available(struct fwnode_handle *ep)
  * The caller is responsible for calling fwnode_handle_put() on the returned
  * fwnode pointer.
  *
- * Return: the fwnode handle of the local endpoint corresponding the port and
- * endpoint IDs or %NULL if not found.
- *
  * If FWNODE_GRAPH_ENDPOINT_NEXT is passed in @flags and the specified endpoint
  * has not been found, look for the closest endpoint ID greater than the
  * specified one and return the endpoint that corresponds to it, if present.
  *
  * Does not return endpoints that belong to disabled devices or endpoints that
  * are unconnected, unless FWNODE_GRAPH_DEVICE_DISABLED is passed in @flags.
+ *
+ * Return: the fwnode handle of the local endpoint corresponding the port and
+ * endpoint IDs or %NULL if not found.
  */
 struct fwnode_handle *
 fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,
-- 
2.47.3
Re: [PATCH v2 05/16] property: Move Return: section of fwnode_graph_get_endpoint_by_id() down
Posted by Jonathan Cameron 2 days, 16 hours ago
On Wed, 24 Sep 2025 10:45:51 +0300
Sakari Ailus <sakari.ailus@linux.intel.com> wrote:

> Move Return: section of fwnode_graph_get_endpoint_by_id() down where it
> habitually is located.

I was rather expecting the kernel-doc documentation to specify this but
it only seems to do so by example.  Hence reasonable to describe it as
you have.

> 
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: Jonathan Cameron <jonathan.cameron@huawei.com>
Re: [PATCH v2 05/16] property: Move Return: section of fwnode_graph_get_endpoint_by_id() down
Posted by Laurent Pinchart 1 week ago
On Wed, Sep 24, 2025 at 10:45:51AM +0300, Sakari Ailus wrote:
> Move Return: section of fwnode_graph_get_endpoint_by_id() down where it
> habitually is located.
> 
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>

> ---
>  drivers/base/property.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/base/property.c b/drivers/base/property.c
> index f626d5bbe806..b52f7b3bbf84 100644
> --- a/drivers/base/property.c
> +++ b/drivers/base/property.c
> @@ -1235,15 +1235,15 @@ static bool fwnode_graph_remote_available(struct fwnode_handle *ep)
>   * The caller is responsible for calling fwnode_handle_put() on the returned
>   * fwnode pointer.
>   *
> - * Return: the fwnode handle of the local endpoint corresponding the port and
> - * endpoint IDs or %NULL if not found.
> - *
>   * If FWNODE_GRAPH_ENDPOINT_NEXT is passed in @flags and the specified endpoint
>   * has not been found, look for the closest endpoint ID greater than the
>   * specified one and return the endpoint that corresponds to it, if present.
>   *
>   * Does not return endpoints that belong to disabled devices or endpoints that
>   * are unconnected, unless FWNODE_GRAPH_DEVICE_DISABLED is passed in @flags.
> + *
> + * Return: the fwnode handle of the local endpoint corresponding the port and
> + * endpoint IDs or %NULL if not found.
>   */
>  struct fwnode_handle *
>  fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,

-- 
Regards,

Laurent Pinchart