diff mbox series

doc: Update bootloader env script file documentation

Message ID 1519563672-7489-1-git-send-email-sami.hartikainen@teleste.com
State Accepted
Headers show
Series doc: Update bootloader env script file documentation | expand

Commit Message

Hartikainen, Sami Feb. 25, 2018, 1:01 p.m. UTC
The bootloader env script file must be defined in the 'bootenv'
section, not in the 'images' section.

Signed-off-by: Sami Hartikainen <sami.hartikainen@teleste.com>
---
 doc/source/sw-description.rst | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

Comments

Stefano Babic Feb. 25, 2018, 1:40 p.m. UTC | #1
Hallo Sami,

On 25/02/2018 14:01, Sami Hartikainen wrote:
> The bootloader env script file must be defined in the 'bootenv'
> section, not in the 'images' section.
> 
> Signed-off-by: Sami Hartikainen <sami.hartikainen@teleste.com>
> ---
>  doc/source/sw-description.rst | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/source/sw-description.rst b/doc/source/sw-description.rst
> index 709febd..2663f5a 100644
> --- a/doc/source/sw-description.rst
> +++ b/doc/source/sw-description.rst
> @@ -64,10 +64,6 @@ The following example explains better the implemented tags:
>  				volume = "splash";
>  			},
>  			{
> -				filename = "bootloader-env";
> -				type = "bootloader";
> -			},
> -			{
>  				filename = "uImage.bin";
>  				volume = "kernel";
>  			},
> @@ -99,6 +95,10 @@ The following example explains better the implemented tags:
>  
>  		bootenv: (
>  			{
> +				filename = "bootloader-env";
> +				type = "bootloader";
> +			},
> +			{
>  				name = "vram";
>  				value = "4M";
>  			},
> @@ -517,10 +517,12 @@ must be chosen from the bootloader selection menu in `menuconfig`.
>  
>  ::
>  
> +	bootenv: (
>  		{
>  			filename = "bootloader-env";
>  			type = "bootloader";
>  		},
> +	)
>  
>  The format of the file is described in U-boot documentation. Each line
>  is in the format
> 

Acked-by: Stefano Babic <sbabic@denx.de>

Best regards,
Stefano Babic
diff mbox series

Patch

diff --git a/doc/source/sw-description.rst b/doc/source/sw-description.rst
index 709febd..2663f5a 100644
--- a/doc/source/sw-description.rst
+++ b/doc/source/sw-description.rst
@@ -64,10 +64,6 @@  The following example explains better the implemented tags:
 				volume = "splash";
 			},
 			{
-				filename = "bootloader-env";
-				type = "bootloader";
-			},
-			{
 				filename = "uImage.bin";
 				volume = "kernel";
 			},
@@ -99,6 +95,10 @@  The following example explains better the implemented tags:
 
 		bootenv: (
 			{
+				filename = "bootloader-env";
+				type = "bootloader";
+			},
+			{
 				name = "vram";
 				value = "4M";
 			},
@@ -517,10 +517,12 @@  must be chosen from the bootloader selection menu in `menuconfig`.
 
 ::
 
+	bootenv: (
 		{
 			filename = "bootloader-env";
 			type = "bootloader";
 		},
+	)
 
 The format of the file is described in U-boot documentation. Each line
 is in the format