Patchwork [U-Boot] README: fix documentation of CONFIG_SHOW_BOOT_PROGRESS

login
register
mail settings
Submitter Wolfgang Denk
Date Oct. 7, 2011, 8:04 a.m.
Message ID <1317974690-6739-1-git-send-email-wd@denx.de>
Download mbox | patch
Permalink /patch/118260/
State Accepted
Commit 4cf2609b0f851169163ed8de3ae6179bc7721762
Headers show

Comments

Wolfgang Denk - Oct. 7, 2011, 8:04 a.m.
SOme previous changes added code right in the middle of the
description of CONFIG_SHOW_BOOT_PROGRESS.  Move this text down.
Fix formatting while we are at it.

Signed-off-by: Wolfgang Denk <wd@denx.de>
---
 README |   72 ++++++++++++++++++++++++++++++++--------------------------------
 1 files changed, 36 insertions(+), 36 deletions(-)
Michael Jones - Oct. 7, 2011, 10:18 a.m.
Hi Wolfgang,

On 10/07/2011 10:04 AM, Wolfgang Denk wrote:
>
> SOme previous changes added code right in the middle of the

typo- double capitalization

> description of CONFIG_SHOW_BOOT_PROGRESS.  Move this text down.
> Fix formatting while we are at it.
>
> Signed-off-by: Wolfgang Denk<wd@denx.de>
> ---
>   README |   72 ++++++++++++++++++++++++++++++++--------------------------------
>   1 files changed, 36 insertions(+), 36 deletions(-)
>
> diff --git a/README b/README
> index 0868531..e0a4d53 100644
> --- a/README
> +++ b/README
> @@ -620,18 +620,18 @@ The following options need to be configured:
>   		the SMC.
>
>   - Pre-Console Buffer:
> -                Prior to the console being initialised (i.e. serial UART
> -                initialised etc) all console output is silently discarded.
> -                Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
> -                buffer any console messages prior to the console being
> -                initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
> -                bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
> -                a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
> -                bytes are output before the console is  initialised, the
> -                earlier bytes are discarded.
> -
> -                'Sane' compilers will generate smaller code if
> -                CONFIG_PRE_CON_BUF_SZ is a power of 2
> +		Prior to the console being initialised (i.e. serial UART
> +		initialised etc) all console output is silently discarded.
> +		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
> +		buffer any console messages prior to the console being
> +		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
> +		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
> +		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
> +		bytes are output before the console is	initialised, the

two spaces between 'is' and 'initialised'

> +		earlier bytes are discarded.
> +
> +		'Sane' compilers will generate smaller code if
> +		CONFIG_PRE_CON_BUF_SZ is a power of 2
>
>   - Boot Delay:	CONFIG_BOOTDELAY - in seconds
>   		Delay before automatically booting the default image;
> @@ -2108,28 +2108,6 @@ The following options need to be configured:
>   		example, some LED's) on your board. At the moment,
>   		the following checkpoints are implemented:
>
> -- Standalone program support:
> -		CONFIG_STANDALONE_LOAD_ADDR
> -
> -		This option allows to define board specific values
> -		for the address where standalone program gets loaded,
> -		thus overwriting the architecutre dependent default
> -		settings.
> -
> -- Frame Buffer Address:
> -	CONFIG_FB_ADDR
> -
> -	Define CONFIG_FB_ADDR if you want to use specific address for
> -	frame buffer.
> -	Then system will reserve the frame buffer address to defined address
> -	instead of lcd_setmem (this function grab the memory for frame buffer
> -	by panel's size).
> -
> -	Please see board_init_f function.
> -
> -	If you want this config option then,
> -	please define it at your board config file
> -
>   Legacy uImage format:
>
>     Arg	Where			When
> @@ -2283,6 +2261,28 @@ FIT uImage format:
>    -150	common/cmd_nand.c	Incorrect FIT image format
>     151	common/cmd_nand.c	FIT image format OK
>
> +- Standalone program support:
> +		CONFIG_STANDALONE_LOAD_ADDR
> +
> +		This option allows to define board specific values

This option defines a board specific value

> +		for the address where standalone program gets loaded,
> +		thus overwriting the architecutre dependent default

'architecture' was misspelled.

> +		settings.
> +
> +- Frame Buffer Address:
> +		CONFIG_FB_ADDR
> +
> +		Define CONFIG_FB_ADDR if you want to use specific
> +		address for frame buffer.
> +		Then system will reserve the frame buffer address to
> +		defined address instead of lcd_setmem (this function
> +		grab the memory for frame buffer by panel's size).

grabs

> +
> +		Please see board_init_f function.
> +
> +		If you want this config option then,
> +		please define it at your board config file

Do we need to say that if you want this option, you need to set it in 
your board config file?  Is there someplace else one would set this 
option if they wanted it?

> +
>   - Automatic software updates via TFTP server
>   		CONFIG_UPDATE_TFTP
>   		CONFIG_UPDATE_TFTP_CNT_MAX
> @@ -2899,8 +2899,8 @@ Low Level (hardware related) configuration options:
>   			* 1ull)<<  32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
>
>   - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
> -		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.  This value is typically
> -		either 0 (32-bit build) or 0xF (36-bit build).  This macro is
> +		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
> +		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
>   		used in assembly code, so it must not contain typecasts or
>   		integer size suffixes (e.g. "ULL").
>

-Michael

MATRIX VISION GmbH, Talstrasse 16, DE-71570 Oppenweiler
Registergericht: Amtsgericht Stuttgart, HRB 271090
Geschaeftsfuehrer: Gerhard Thullner, Werner Armingeon, Uwe Furtner, Erhard Meier
Wolfgang Denk - Oct. 9, 2011, 7:06 p.m.
Dear Michael Jones,

In message <4E8ED1EF.8020502@matrix-vision.de> you wrote:
> 
> > SOme previous changes added code right in the middle of the
> 
> typo- double capitalization

Thanks for pointing out.

> > +		bytes are output before the console is	initialised, the
> 
> two spaces between 'is' and 'initialised'

It's actually a TAB.  I will submit a separate patch for this and your
other comments.


> 
> > +
> > +		Please see board_init_f function.
> > +
> > +		If you want this config option then,
> > +		please define it at your board config file
> 
> Do we need to say that if you want this option, you need to set it in 
> your board config file?  Is there someplace else one would set this 
> option if they wanted it?

Not really, indeed.


Thanks, patch following.

Best regards,

Wolfgang Denk
Wolfgang Denk - Oct. 9, 2011, 8:55 p.m.
Dear Wolfgang Denk,

In message <1317974690-6739-1-git-send-email-wd@denx.de> you wrote:
> SOme previous changes added code right in the middle of the
> description of CONFIG_SHOW_BOOT_PROGRESS.  Move this text down.
> Fix formatting while we are at it.
> 
> Signed-off-by: Wolfgang Denk <wd@denx.de>
> ---
>  README |   72 ++++++++++++++++++++++++++++++++--------------------------------
>  1 files changed, 36 insertions(+), 36 deletions(-)

Applied, thanks.

Best regards,

Wolfgang Denk

Patch

diff --git a/README b/README
index 0868531..e0a4d53 100644
--- a/README
+++ b/README
@@ -620,18 +620,18 @@  The following options need to be configured:
 		the SMC.
 
 - Pre-Console Buffer:
-                Prior to the console being initialised (i.e. serial UART
-                initialised etc) all console output is silently discarded.
-                Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
-                buffer any console messages prior to the console being
-                initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
-                bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
-                a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
-                bytes are output before the console is  initialised, the
-                earlier bytes are discarded.
-
-                'Sane' compilers will generate smaller code if
-                CONFIG_PRE_CON_BUF_SZ is a power of 2
+		Prior to the console being initialised (i.e. serial UART
+		initialised etc) all console output is silently discarded.
+		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
+		buffer any console messages prior to the console being
+		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
+		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
+		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
+		bytes are output before the console is	initialised, the
+		earlier bytes are discarded.
+
+		'Sane' compilers will generate smaller code if
+		CONFIG_PRE_CON_BUF_SZ is a power of 2
 
 - Boot Delay:	CONFIG_BOOTDELAY - in seconds
 		Delay before automatically booting the default image;
@@ -2108,28 +2108,6 @@  The following options need to be configured:
 		example, some LED's) on your board. At the moment,
 		the following checkpoints are implemented:
 
-- Standalone program support:
-		CONFIG_STANDALONE_LOAD_ADDR
-
-		This option allows to define board specific values
-		for the address where standalone program gets loaded,
-		thus overwriting the architecutre dependent default
-		settings.
-
-- Frame Buffer Address:
-	CONFIG_FB_ADDR
-
-	Define CONFIG_FB_ADDR if you want to use specific address for
-	frame buffer.
-	Then system will reserve the frame buffer address to defined address
-	instead of lcd_setmem (this function grab the memory for frame buffer
-	by panel's size).
-
-	Please see board_init_f function.
-
-	If you want this config option then,
-	please define it at your board config file
-
 Legacy uImage format:
 
   Arg	Where			When
@@ -2283,6 +2261,28 @@  FIT uImage format:
  -150	common/cmd_nand.c	Incorrect FIT image format
   151	common/cmd_nand.c	FIT image format OK
 
+- Standalone program support:
+		CONFIG_STANDALONE_LOAD_ADDR
+
+		This option allows to define board specific values
+		for the address where standalone program gets loaded,
+		thus overwriting the architecutre dependent default
+		settings.
+
+- Frame Buffer Address:
+		CONFIG_FB_ADDR
+
+		Define CONFIG_FB_ADDR if you want to use specific
+		address for frame buffer.
+		Then system will reserve the frame buffer address to
+		defined address instead of lcd_setmem (this function
+		grab the memory for frame buffer by panel's size).
+
+		Please see board_init_f function.
+
+		If you want this config option then,
+		please define it at your board config file
+
 - Automatic software updates via TFTP server
 		CONFIG_UPDATE_TFTP
 		CONFIG_UPDATE_TFTP_CNT_MAX
@@ -2899,8 +2899,8 @@  Low Level (hardware related) configuration options:
 			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
 
 - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
-		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.  This value is typically
-		either 0 (32-bit build) or 0xF (36-bit build).  This macro is
+		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
+		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
 		used in assembly code, so it must not contain typecasts or
 		integer size suffixes (e.g. "ULL").