Re: [PATCH 1/3] overlay: Documentation for the overlay sugar syntax

[Frank Rowand <frowand.list-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>]

Hi David, Pantelis,

On 06/14/17 07:53, Pantelis Antoniou wrote:
> There exists a syntactic sugar version of overlays which
> make them simpler to write for the trivial case of a single target.
> 
> Document it in the device tree object internals.
> 
> Signed-off-by: Pantelis Antoniou <pantelis.antoniou-OWPKS81ov/FWk0Htik3J/w@public.gmane.org>
> ---
>  Documentation/dt-object-internal.txt | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/Documentation/dt-object-internal.txt b/Documentation/dt-object-internal.txt
> index 51d68ab..624aa43 100644
> --- a/Documentation/dt-object-internal.txt
> +++ b/Documentation/dt-object-internal.txt
> @@ -308,3 +308,20 @@ the run time loader must apply an offset to each phandle in every dynamic
>  DT object loaded. The __local_fixups__ node records the offset relative to the
>  start of every local reference within that property so that the loader can apply
>  the offset.
> +
> +There is an alternative syntax to the expanded form for overlays with phandle
> +targets which makes the format similar to the one using in .dtsi include files.
> +
> +So for the &ocp target example above one can simply write:
> +
> +/dts-v1/;
> +/plugin/;
> +&ocp {
> +	/* bar peripheral */
> +	bar {
> +		compatible = "corp,bar";
> +		... /* various properties and child nodes */
> +	}
> +};
> +
> +The resulting dtb object is identical.


Ignoring the fact that this file describes the device tree internals
instead of the device tree source format -- did we decide that we can
deprecate specifying nodes __symbols__,  __overlay__, __fixups__, and
__local_fixups__ (any node name beginning with an underscore) in
device tree source.  Then at a future date make node names beginning
with an underscore an error (maybe with a command line flag to override
the error?)?

-Frank