diff options
| author |   Frank Rowand <frank.rowand@sony.com> | 2017-10-17 16:36:23 -0700 |
|---|---|---|
| committer |   Rob Herring <robh@kernel.org> | 2017-10-17 20:46:17 -0500 |
| commit | 0290c4ca2536a35e55c53cfb9058465b1f987b17 (patch) | |
| tree | 310203536e1dafb5cf6c0b8287e2ed83de0876ec /Documentation/devicetree/overlay-notes.txt | |
| parent | of: overlay.c: Convert comparisons to zero or NULL to logical expressions (diff) | |
| download | linux-dev-0290c4ca2536a35e55c53cfb9058465b1f987b17.tar.xz linux-dev-0290c4ca2536a35e55c53cfb9058465b1f987b17.zip | |
of: overlay: rename identifiers to more reflect what they do
This patch is aimed primarily at drivers/of/overlay.c, but those
changes also have a small impact in a few other files.
overlay.c is difficult to read and maintain. Improve readability:
- Rename functions, types and variables to better reflect what
they do and to be consistent with names in other places,
such as the device tree overlay FDT (flattened device tree),
and make the algorithms more clear
- Use the same names consistently throughout the file
- Update comments for name changes
- Fix incorrect comments
This patch is intended to not introduce any functional change.
Signed-off-by: Frank Rowand <frank.rowand@sony.com>
Signed-off-by: Rob Herring <robh@kernel.org>
Diffstat (limited to 'Documentation/devicetree/overlay-notes.txt')
| -rw-r--r-- | Documentation/devicetree/overlay-notes.txt | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/devicetree/overlay-notes.txt b/Documentation/devicetree/overlay-notes.txt index eb7f2685fda1..c4aa0adf13ec 100644 --- a/Documentation/devicetree/overlay-notes.txt +++ b/Documentation/devicetree/overlay-notes.txt @@ -87,15 +87,15 @@ Overlay in-kernel API The API is quite easy to use. -1. Call of_overlay_create() to create and apply an overlay. The return value -is a cookie identifying this overlay. +1. Call of_overlay_apply() to create and apply an overlay changeset. The return +value is an error or a cookie identifying this overlay. -2. Call of_overlay_destroy() to remove and cleanup the overlay previously -created via the call to of_overlay_create(). Removal of an overlay that -is stacked by another will not be permitted. +2. Call of_overlay_remove() to remove and cleanup the overlay changeset +previously created via the call to of_overlay_apply(). Removal of an overlay +changeset that is stacked by another will not be permitted. Finally, if you need to remove all overlays in one-go, just call -of_overlay_destroy_all() which will remove every single one in the correct +of_overlay_remove_all() which will remove every single one in the correct order. Overlay DTS Format |