diff mbox

[U-Boot,2/2] doc: Use KBUILD_OUTPUT instead of BUILD_DIR

Message ID 1409317630-14270-2-git-send-email-jagannadh.teki@gmail.com
State Superseded
Headers show

Commit Message

Jagan Teki Aug. 29, 2014, 1:07 p.m. UTC
Now saving output files in a separate directory through
KBUILD_OUTPUT not with BUILD_DIR, so updated the documentation
accordingly.

Signed-off-by: Jagannadha Sutradharudu Teki <jagannadh.teki@gmail.com>
---
 MAKEALL             | 12 ++++++------
 README              | 10 +++++-----
 doc/README.kwbimage |  4 ++--
 3 files changed, 13 insertions(+), 13 deletions(-)

Comments

Masahiro Yamada Sept. 1, 2014, 4:34 a.m. UTC | #1
Hi Jagan,



On Fri, 29 Aug 2014 18:37:10 +0530
Jagannadha Sutradharudu Teki <jagannadh.teki@gmail.com> wrote:

> Now saving output files in a separate directory through
> KBUILD_OUTPUT not with BUILD_DIR, so updated the documentation
> accordingly.
> 
> Signed-off-by: Jagannadha Sutradharudu Teki <jagannadh.teki@gmail.com>


I am afraid you are confused.

The "BUILD_DIR" variable in MAKEALL has nothing to do with
the "BUILD_DIR" variable which the core build system used to use
prior to Kbuild.


MAKEALL is an upper level utility which is separated from Kbuild.




>  MAKEALL             | 12 ++++++------
>  README              | 10 +++++-----
>  doc/README.kwbimage |  4 ++--
>  3 files changed, 13 insertions(+), 13 deletions(-)
> 
> diff --git a/MAKEALL b/MAKEALL
> index 392ea8d..42f09e8 100755
> --- a/MAKEALL
> +++ b/MAKEALL
> @@ -42,7 +42,7 @@ usage()
>  			   architecture "ARCH".  Substitute "ARCH" for any
>  			   supported architecture (default: "")
>  	  MAKEALL_LOGDIR   output all logs to here (default: ./LOG/)
> -	  BUILD_DIR        output build directory (default: ./)
> +	  KBUILD_OUTPUT	   output build directory (default: ./)
>  	  BUILD_NBUILDS	   number of parallel targets (default: 1)
>  
>  	Examples:
> @@ -223,14 +223,14 @@ BUILD_MANY=0
>  
>  if [ "${BUILD_NBUILDS}" -gt 1 ] ; then
>  	BUILD_MANY=1
> -	: ${BUILD_DIR:=./build}
> -	mkdir -p "${BUILD_DIR}/ERR"
> -	find "${BUILD_DIR}/ERR/" -type f -exec rm -f {} +
> +	: ${KBUILD_OUTPUT:=./build}
> +	mkdir -p "${KBUILD_OUTPUT}/ERR"
> +	find "${KBUILD_OUTPUT}/ERR/" -type f -exec rm -f {} +
>  fi
>  
> -: ${BUILD_DIR:=.}
> +: ${KBUILD_OUTPUT:=.}
>  
> -OUTPUT_PREFIX="${BUILD_DIR}"
> +OUTPUT_PREFIX="${KBUILD_OUTPUT}"
>  
>  [ -d ${LOG_DIR} ] || mkdir "${LOG_DIR}" || exit 1
>  if [ "$CONTINUE" != 'y' -a "$REBUILD_ERRORS" != 'y' ] ; then


You do not need to change MAKEALL.
"BUILD_DIR" is a variable used only inside this utility.
It is totally unrelated to Kbuild.





> diff --git a/README b/README
> index e88184b..8e05f69 100644
> --- a/README
> +++ b/README
> @@ -4969,14 +4969,14 @@ this behavior and build U-Boot to some external directory:
>  	make O=/tmp/build NAME_defconfig
>  	make O=/tmp/build all
>  
> -2. Set environment variable BUILD_DIR to point to the desired location:
> +2. Set environment variable KBUILD_OUTPUT to point to the desired location:
>  
> -	export BUILD_DIR=/tmp/build
> +	export KBUILD_OUTPUT=/tmp/build
>  	make distclean
>  	make NAME_defconfig
>  	make all
>  
> -Note that the command line "O=" setting overrides the BUILD_DIR environment
> +Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
>  variable.
>  


Correct.




> @@ -5032,13 +5032,13 @@ or to build on a native PowerPC system you can type
>  
>  When using the MAKEALL script, the default behaviour is to build
>  U-Boot in the source directory. This location can be changed by
> -setting the BUILD_DIR environment variable. Also, for each target
> +setting the KBUILD_OUTPUT environment variable. Also, for each target
>  built, the MAKEALL script saves two log files (<target>.ERR and
>  <target>.MAKEALL) in the <source dir>/LOG directory. This default
>  location can be changed by setting the MAKEALL_LOGDIR environment
>  variable. For example:
>  
> -	export BUILD_DIR=/tmp/build
> +	export KBUILD_OUTPUT=/tmp/build
>  	export MAKEALL_LOGDIR=/tmp/log
>  	CROSS_COMPILE=ppc_8xx- MAKEALL


Incorrect.





> diff --git a/doc/README.kwbimage b/doc/README.kwbimage
> index 13f6f92..8c02298 100644
> --- a/doc/README.kwbimage
> +++ b/doc/README.kwbimage
> @@ -30,10 +30,10 @@ kwbimage support available with mkimage utility will generate kirkwood boot
>  image that can be flashed on the board NAND/SPI flash.  The make target
>  which uses mkimage to produce such an image is "u-boot.kwb".  For example:
>  
> -  export BUILD_DIR=/tmp/build
> +  export KBUILD_OUTPUT=/tmp/build
>    make distclean
>    make yourboard_config
> -  make $BUILD_DIR/u-boot.kwb
> +  make $KBUILD_OUTPUT/u-boot.kwb
>  
>  
>  Board specific configuration file specifications:


The first one is correct.

The second one should be:
make u-boot.kwb

While you are here, please also fix  s/yourboard_config/yourboard_defconfig/





Best Regards
Masahiro Yamada
diff mbox

Patch

diff --git a/MAKEALL b/MAKEALL
index 392ea8d..42f09e8 100755
--- a/MAKEALL
+++ b/MAKEALL
@@ -42,7 +42,7 @@  usage()
 			   architecture "ARCH".  Substitute "ARCH" for any
 			   supported architecture (default: "")
 	  MAKEALL_LOGDIR   output all logs to here (default: ./LOG/)
-	  BUILD_DIR        output build directory (default: ./)
+	  KBUILD_OUTPUT	   output build directory (default: ./)
 	  BUILD_NBUILDS	   number of parallel targets (default: 1)
 
 	Examples:
@@ -223,14 +223,14 @@  BUILD_MANY=0
 
 if [ "${BUILD_NBUILDS}" -gt 1 ] ; then
 	BUILD_MANY=1
-	: ${BUILD_DIR:=./build}
-	mkdir -p "${BUILD_DIR}/ERR"
-	find "${BUILD_DIR}/ERR/" -type f -exec rm -f {} +
+	: ${KBUILD_OUTPUT:=./build}
+	mkdir -p "${KBUILD_OUTPUT}/ERR"
+	find "${KBUILD_OUTPUT}/ERR/" -type f -exec rm -f {} +
 fi
 
-: ${BUILD_DIR:=.}
+: ${KBUILD_OUTPUT:=.}
 
-OUTPUT_PREFIX="${BUILD_DIR}"
+OUTPUT_PREFIX="${KBUILD_OUTPUT}"
 
 [ -d ${LOG_DIR} ] || mkdir "${LOG_DIR}" || exit 1
 if [ "$CONTINUE" != 'y' -a "$REBUILD_ERRORS" != 'y' ] ; then
diff --git a/README b/README
index e88184b..8e05f69 100644
--- a/README
+++ b/README
@@ -4969,14 +4969,14 @@  this behavior and build U-Boot to some external directory:
 	make O=/tmp/build NAME_defconfig
 	make O=/tmp/build all
 
-2. Set environment variable BUILD_DIR to point to the desired location:
+2. Set environment variable KBUILD_OUTPUT to point to the desired location:
 
-	export BUILD_DIR=/tmp/build
+	export KBUILD_OUTPUT=/tmp/build
 	make distclean
 	make NAME_defconfig
 	make all
 
-Note that the command line "O=" setting overrides the BUILD_DIR environment
+Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
 variable.
 
 
@@ -5032,13 +5032,13 @@  or to build on a native PowerPC system you can type
 
 When using the MAKEALL script, the default behaviour is to build
 U-Boot in the source directory. This location can be changed by
-setting the BUILD_DIR environment variable. Also, for each target
+setting the KBUILD_OUTPUT environment variable. Also, for each target
 built, the MAKEALL script saves two log files (<target>.ERR and
 <target>.MAKEALL) in the <source dir>/LOG directory. This default
 location can be changed by setting the MAKEALL_LOGDIR environment
 variable. For example:
 
-	export BUILD_DIR=/tmp/build
+	export KBUILD_OUTPUT=/tmp/build
 	export MAKEALL_LOGDIR=/tmp/log
 	CROSS_COMPILE=ppc_8xx- MAKEALL
 
diff --git a/doc/README.kwbimage b/doc/README.kwbimage
index 13f6f92..8c02298 100644
--- a/doc/README.kwbimage
+++ b/doc/README.kwbimage
@@ -30,10 +30,10 @@  kwbimage support available with mkimage utility will generate kirkwood boot
 image that can be flashed on the board NAND/SPI flash.  The make target
 which uses mkimage to produce such an image is "u-boot.kwb".  For example:
 
-  export BUILD_DIR=/tmp/build
+  export KBUILD_OUTPUT=/tmp/build
   make distclean
   make yourboard_config
-  make $BUILD_DIR/u-boot.kwb
+  make $KBUILD_OUTPUT/u-boot.kwb
 
 
 Board specific configuration file specifications: