Skip to contentSkip to conversation

README: fix documentation of CONFIG_SHOW_BOOT_PROGRESS

PATCH New Wolfgang Denk 2 participants 6 messages Oct 7, 2011 – Oct 9, 2011

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 README: fix documentation of CONFIG_SHOW_BOOT_PROGRESS

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.

---
 README |   72 ++++++++++++++++++++++++++++++++--------------------------------
 1 files changed, 36 insertions(+), 36 deletions(-)
README +36 -36
index 0868531..e0a4d53 100644
@@ -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").
 
Signature · 1 line
1.7.6.2
#1 lore raw

PATCH 1/1 README: fix documentation of CONFIG_SHOW_BOOT_PROGRESS

Hi Wolfgang,

Quoted 2 lines · Wolfgang Denk

SOme previous changes added code right in the middle of the

typo- double capitalization

Quoted 26 lines

description of CONFIG_SHOW_BOOT_PROGRESS. Move this text down. Fix formatting while we are at it.

---
  README |   72 ++++++++++++++++++++++++++++++++--------------------------------
  1 files changed, 36 insertions(+), 36 deletions(-)
README +0 -10
index 0868531..e0a4d53 100644
@@ -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.
-

README The following options need to be configured: · line 630

Quoted 10 lines
README +8 -2
-                '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'

Quoted 37 lines
README +4 -22
+		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

README FIT uImage format: · line 2267

Quoted 7 lines
README +4 -0
@@ -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

README FIT uImage format: · line 2269

Quoted 2 lines
README +2 -0
+		for the address where standalone program gets loaded,
+		thus overwriting the architecutre dependent default

'architecture' was misspelled.

README FIT uImage format: · line 2279

Quoted 10 lines
README +10 -0
+		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

README FIT uImage format: · line 2284

Quoted 5 lines
README +5 -0
+
+		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?

Quoted 5 lines
README +1 -0
+
  - Automatic software updates via TFTP server
  		CONFIG_UPDATE_TFTP
  		CONFIG_UPDATE_TFTP_CNT_MAX

README Low Level (hardware related) configuration options: · line 2906

Quoted 10 lines
README +2 -2
@@ -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

#2 lore raw

PATCH 1/1 README: fix documentation of CONFIG_SHOW_BOOT_PROGRESS

Dear Michael Jones,

Quoted 4 lines · In message <[email protected]> you wrote:
Quoted 2 lines

SOme previous changes added code right in the middle of the

typo- double capitalization

Thanks for pointing out.

Quoted 3 lines

README The following options need to be configured: · line 630

Quoted 1 line
README +1 -0
+		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.

Quoted 10 lines

README FIT uImage format: · line 2284

Quoted 6 lines
README +5 -0
+
+		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

Signature · 6 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
Shakespeare's Law of Prototyping: (Hamlet III, iv, 156-160)
        O, throw away the worser part of it,
        And live the purer with the other half.
#3 lore raw

PATCH 1/1 README: fix typos and such.

In reply to Michael Jones
---
 README |   13 +++++--------
 1 files changed, 5 insertions(+), 8 deletions(-)
README +5 -8
index e0a4d53..c5cfb13 100644
@@ -627,7 +627,7 @@ The following options need to be configured:
 		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
+		bytes are output before the console is initialised, the
 		earlier bytes are discarded.
 
 		'Sane' compilers will generate smaller code if
@@ -2264,9 +2264,9 @@ FIT uImage format:
 - 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
+		This option defines a board specific value for the
+		address where standalone program gets loaded, thus
+		overwriting the architecture dependent default
 		settings.
 
 - Frame Buffer Address:
@@ -2276,13 +2276,10 @@ FIT uImage format:
 		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 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
Signature · 1 line
1.7.6.2
author Applied
#4 lore raw

PATCH 1/1 README: fix typos and such.

Dear Wolfgang Denk,

Quoted 5 lines · In message <[email protected]> you wrote:
---
 README |   13 +++++--------
 1 files changed, 5 insertions(+), 8 deletions(-)

Applied, thanks.

Best regards,

Wolfgang Denk

Signature · 4 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
Another megabytes the dust.
author Applied
#5 lore raw

PATCH 1/1 README: fix documentation of CONFIG_SHOW_BOOT_PROGRESS

In reply to Wolfgang Denk

Dear Wolfgang Denk,

Quoted 8 lines · In message <[email protected]> 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.

---
 README |   72 ++++++++++++++++++++++++++++++++--------------------------------
 1 files changed, 36 insertions(+), 36 deletions(-)

Applied, thanks.

Best regards,

Wolfgang Denk

Signature · 4 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
Democracy is mob rule, but with income taxes.