2019-04-04 02:26:57

by Chris Packham

Subject: [PATCH] of: Documentation: Correct return value from of_overlay_fdt_apply

The return from of_overlay_fdt_apply() just indicates success or fail.
The cookie is returned via reference.

Signed-off-by: Chris Packham <[email protected]>
---
Documentation/devicetree/overlay-notes.txt | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/overlay-notes.txt b/Documentation/devicetree/overlay-notes.txt
index 725fb8d255c1..62f2003d6205 100644
--- a/Documentation/devicetree/overlay-notes.txt
+++ b/Documentation/devicetree/overlay-notes.txt
@@ -88,7 +88,8 @@ Overlay in-kernel API
The API is quite easy to use.

1. Call of_overlay_fdt_apply() to create and apply an overlay changeset. The
-return value is an error or a cookie identifying this overlay.
+return indicates success or failure. A a cookie identifying this overlay is
+returned via reference on success.

2. Call of_overlay_remove() to remove and cleanup the overlay changeset
previously created via the call to of_overlay_fdt_apply(). Removal of an
--
2.21.0

2019-04-08 01:13:27

by Frank Rowand

Subject: Re: [PATCH] of: Documentation: Correct return value from of_overlay_fdt_apply

On 4/3/19 7:25 PM, Chris Packham wrote:
> The return from of_overlay_fdt_apply() just indicates success or fail.
> The cookie is returned via reference.
>
> Signed-off-by: Chris Packham <[email protected]>
> ---
> Documentation/devicetree/overlay-notes.txt | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/devicetree/overlay-notes.txt b/Documentation/devicetree/overlay-notes.txt
> index 725fb8d255c1..62f2003d6205 100644
> --- a/Documentation/devicetree/overlay-notes.txt
> +++ b/Documentation/devicetree/overlay-notes.txt
> @@ -88,7 +88,8 @@ Overlay in-kernel API
> The API is quite easy to use.
>
> 1. Call of_overlay_fdt_apply() to create and apply an overlay changeset. The
> -return value is an error or a cookie identifying this overlay.
> +return indicates success or failure. A a cookie identifying this overlay is
> +returned via reference on success.
>
> 2. Call of_overlay_remove() to remove and cleanup the overlay changeset
> previously created via the call to of_overlay_fdt_apply(). Removal of an
>

Reviewed-by: Frank Rowand <[email protected]>