[PATCH] manual: Fix and improve documentation about -@

[PATCH] manual: Fix and improve documentation about -@

[Uwe Kleine-König]

Device trees with a /plugin/ tag ("overlays") generate a __fixups__ node
when needed and independent of -q being given or not. The same is true for
__local__fixups__. So don't mention these two nodes in the paragraph about
-@.

To not shorten the description too much, describe the semantic of the
properties contained in the generated __symbols__ node.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig-bIcnvbaLZ9MEGnE8C9+IrQ@public.gmane.org>
---
 Documentation/manual.txt | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/Documentation/manual.txt b/Documentation/manual.txt
index 2087a4d3e754..15a7837d3cef 100644
--- a/Documentation/manual.txt
+++ b/Documentation/manual.txt
@@ -122,12 +122,10 @@ Options:
 	Relevant for dtb and asm output only.
 
     -@
-	Generates a __symbols__ node at the root node of the resulting blob
-	for any node labels used, and for any local references using phandles
-	it also generates a __local_fixups__ node that tracks them.
+	Generates a __symbols__ node at the root node. This node contains a
+	property for each label. The property's name is the label name and the
+	value is the path of the labeled node.
 
-	When using the /plugin/ tag all unresolved label references to
-	be tracked in the __fixups__ node, making dynamic resolution possible.
 
     -A
 	Generate automatically aliases for all node labels. This is similar to
-- 
2.39.2

Re: [PATCH] manual: Fix and improve documentation about -@

[David Gibson]

[-- Attachment #1: Type: text/plain, Size: 1781 bytes --]

On Mon, Apr 24, 2023 at 05:28:02PM +0200, Uwe Kleine-König wrote:
> Device trees with a /plugin/ tag ("overlays") generate a __fixups__ node
> when needed and independent of -q being given or not. The same is true for
> __local__fixups__. So don't mention these two nodes in the paragraph about
> -@.
> 
> To not shorten the description too much, describe the semantic of the
> properties contained in the generated __symbols__ node.
> 
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig-bIcnvbaLZ9MEGnE8C9+IrQ@public.gmane.org>

Applied, thanks.

> ---
>  Documentation/manual.txt | 8 +++-----
>  1 file changed, 3 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/manual.txt b/Documentation/manual.txt
> index 2087a4d3e754..15a7837d3cef 100644
> --- a/Documentation/manual.txt
> +++ b/Documentation/manual.txt
> @@ -122,12 +122,10 @@ Options:
>  	Relevant for dtb and asm output only.
>  
>      -@
> -	Generates a __symbols__ node at the root node of the resulting blob
> -	for any node labels used, and for any local references using phandles
> -	it also generates a __local_fixups__ node that tracks them.
> +	Generates a __symbols__ node at the root node. This node contains a
> +	property for each label. The property's name is the label name and the
> +	value is the path of the labeled node.
>  
> -	When using the /plugin/ tag all unresolved label references to
> -	be tracked in the __fixups__ node, making dynamic resolution possible.
>  
>      -A
>  	Generate automatically aliases for all node labels. This is similar to

-- 
David Gibson			| I'll have my music baroque, and my code
david AT gibson.dropbear.id.au	| minimalist, thank you.  NOT _the_ _other_
				| _way_ _around_!
http://www.ozlabs.org/~dgibson

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]