diff mbox

[U-Boot,v2,1/2] sandbox: Update minor documentation changes

Message ID 1409500183-4038-1-git-send-email-jaganna@xilinx.com
State Accepted
Delegated to: Simon Glass
Headers show

Commit Message

Jagan Teki Aug. 31, 2014, 3:49 p.m. UTC 
From: Jagannadha Sutradharudu Teki <jaganna@gmail.com>

- Use _defconfig instead of _config, but still _config is working.
- Corrected README.sandbox path in ./README

Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@gmail.com>
---
Changes for v2:
	- Fixed board path in 'board/sandbox/README.sandbox' 

 README                       | 2 +-
 board/sandbox/README.sandbox | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

Comments

Simon Glass Sept. 1, 2014, 4:17 a.m. UTC | #1 
On 31 August 2014 08:49, Jagannadha Sutradharudu Teki
<jagannadh.teki@gmail.com> wrote:
> From: Jagannadha Sutradharudu Teki <jaganna@gmail.com>
>
> - Use _defconfig instead of _config, but still _config is working.
> - Corrected README.sandbox path in ./README
>
> Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@gmail.com>

Thanks.

Acked-by: Simon Glass <sjg@chromium.org>

Regards,
Simon
Masahiro Yamada Sept. 1, 2014, 4:24 a.m. UTC | #2 
Hi Jagan,



On Sun, 31 Aug 2014 21:19:43 +0530
Jagannadha Sutradharudu Teki <jagannadh.teki@gmail.com> wrote:

> diff --git a/README b/README
> index 1e63f04..e88184b 100644
> --- a/README
> +++ b/README
> @@ -272,7 +272,7 @@ board. This allows feature development which is not board- or architecture-
>  specific to be undertaken on a native platform. The sandbox is also used to
>  run some of U-Boot's tests.
>  
> -See board/sandbox/sandbox/README.sandbox for more details.
> +See board/sandbox/README.sandbox for more details.
>  
>  
>  Configuration Options:
> diff --git a/board/sandbox/README.sandbox b/board/sandbox/README.sandbox
> index 529c447..5f879f5 100644
> --- a/board/sandbox/README.sandbox
> +++ b/board/sandbox/README.sandbox
> @@ -19,7 +19,7 @@ create unit tests which we can run to test this upper level code.
>  CONFIG_SANDBOX is defined when building a native board.
>  
>  The chosen vendor and board names are also 'sandbox', so there is a single
> -board in board/sandbox/sandbox.
> +board in board/sandbox.
>  

This is not what I meant.
Please write a description that makes sense here.


(Note:
The board directory is board/$(VENDOR)/$(BOARD), or board/$(BOARD) if VENDOR is not set.
Sandbox dropped the vendor name, therefore the board directory is board/sandbox now.)




Best Regards
Masahiro Yamada
Simon Glass Sept. 26, 2014, 6:55 p.m. UTC | #3 
On 31 August 2014 22:24, Masahiro Yamada <yamada.m@jp.panasonic.com> wrote:
>
> Hi Jagan,
>
>
>
> On Sun, 31 Aug 2014 21:19:43 +0530
> Jagannadha Sutradharudu Teki <jagannadh.teki@gmail.com> wrote:
>
> > diff --git a/README b/README
> > index 1e63f04..e88184b 100644
> > --- a/README
> > +++ b/README
> > @@ -272,7 +272,7 @@ board. This allows feature development which is not board- or architecture-
> >  specific to be undertaken on a native platform. The sandbox is also used to
> >  run some of U-Boot's tests.
> >
> > -See board/sandbox/sandbox/README.sandbox for more details.
> > +See board/sandbox/README.sandbox for more details.
> >
> >
> >  Configuration Options:
> > diff --git a/board/sandbox/README.sandbox b/board/sandbox/README.sandbox
> > index 529c447..5f879f5 100644
> > --- a/board/sandbox/README.sandbox
> > +++ b/board/sandbox/README.sandbox
> > @@ -19,7 +19,7 @@ create unit tests which we can run to test this upper level code.
> >  CONFIG_SANDBOX is defined when building a native board.
> >
> >  The chosen vendor and board names are also 'sandbox', so there is a single
> > -board in board/sandbox/sandbox.
> > +board in board/sandbox.
> >
>
> This is not what I meant.
> Please write a description that makes sense here.
>
>
> (Note:
> The board directory is board/$(VENDOR)/$(BOARD), or board/$(BOARD) if VENDOR is not set.
> Sandbox dropped the vendor name, therefore the board directory is board/sandbox now.)
>

Applied to u-boot-x86/misc and now in mainline.

See this for the follow-up:

http://patchwork.ozlabs.org/patch/392637/
diff mbox

Patch

diff --git a/README b/README
index 1e63f04..e88184b 100644
--- a/README
+++ b/README
@@ -272,7 +272,7 @@  board. This allows feature development which is not board- or architecture-
 specific to be undertaken on a native platform. The sandbox is also used to
 run some of U-Boot's tests.
 
-See board/sandbox/sandbox/README.sandbox for more details.
+See board/sandbox/README.sandbox for more details.
 
 
 Configuration Options:
diff --git a/board/sandbox/README.sandbox b/board/sandbox/README.sandbox
index 529c447..5f879f5 100644
--- a/board/sandbox/README.sandbox
+++ b/board/sandbox/README.sandbox
@@ -19,7 +19,7 @@  create unit tests which we can run to test this upper level code.
 CONFIG_SANDBOX is defined when building a native board.
 
 The chosen vendor and board names are also 'sandbox', so there is a single
-board in board/sandbox/sandbox.
+board in board/sandbox.
 
 CONFIG_SANDBOX_BIG_ENDIAN should be defined when running on big-endian
 machines.
@@ -32,7 +32,7 @@  Basic Operation
 
 To run sandbox U-Boot use something like:
 
-   make sandbox_config all
+   make sandbox_defconfig all
    ./u-boot
 
 Note:
@@ -41,7 +41,7 @@  Note:
    build sandbox without SDL (i.e. no display/keyboard support) by removing
    the CONFIG_SANDBOX_SDL line in include/configs/sandbox.h or using:
 
-      make sandbox_config all NO_SDL=1
+      make sandbox_defconfig all NO_SDL=1
       ./u-boot