[RESEND PATCH] of: Documentation: Correct return value from of_overlay_fdt_apply
From: Chris Packham
Date: Wed Oct 23 2019 - 23:02:42 EST
The return from of_overlay_fdt_apply() just indicates success or fail.
The cookie is returned via reference.
Signed-off-by: Chris Packham <chris.packham@xxxxxxxxxxxxxxxxxxx>
---
Just going over some old branches and saw this hadn't been picked up. I wonder
if it got caught between maintainers.
Review from Frank:
https://lore.kernel.org/lkml/9bb707be-9cb3-dffc-303f-ee7025090ba9@xxxxxxxxx/
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.23.0