Skip to contentSkip to conversation

doc: fix documentation of output directory

PATCH New Timo Ketola 4 participants 6 messages Nov 4, 2014 – Nov 10, 2014

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: fix documentation of output directory

Correct environment variable is KBUILD_OUTPUT.

---
 README              |    6 +++---
 doc/README.kwbimage |    4 ++--
 2 files changed, 5 insertions(+), 5 deletions(-)
README +3 -3
index 7b5538e..c3a9dfc 100644
@@ -5012,14 +5012,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.
 
 
doc/README.kwbimage +2 -2
index 13f6f92..8c02298 100644
@@ -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:
Signature · 1 line
1.7.9.5
#1 lore raw

PATCH 1/1 doc: fix documentation of output directory

Hi Timo,

doc/README.kwbimage kwbimage support available with mkimage utility will generate kirkwood boot · line 33

Quoted 11 lines · On Tue, 4 Nov 2014 12:56:50 +0200 Timo Ketola <[email protected]> wrote:
doc/README.kwbimage +1 -1
index 13f6f92..8c02298 100644
@@ -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

Correct.

doc/README.kwbimage kwbimage support available with mkimage utility will generate kirkwood boot · line 38

Quoted 6 lines
doc/README.kwbimage +1 -1
   make distclean
   make yourboard_config
-  make $BUILD_DIR/u-boot.kwb
+  make $KBUILD_OUTPUT/u-boot.kwb
 
 

Should be
make yourboard_defconfig
make u-boot.kwb

Best Regards
Masahiro Yamada

#2 lore raw

PATCH 1/1 doc: fix documentation of output directory

Quoted 10 lines · Masahiro Yamada

doc/README.kwbimage kwbimage support available with mkimage utility will generate kirkwood boot · line 36

Quoted 4 lines · On Tue, 4 Nov 2014 12:56:50 +0200 Timo Ketola <[email protected]> wrote:

make distclean
make yourboard_config

doc/README.kwbimage +1 -1
-  make $BUILD_DIR/u-boot.kwb
+  make $KBUILD_OUTPUT/u-boot.kwb

Should be
make yourboard_defconfig
make u-boot.kwb

Sounds logical. But that means that the older version was already broken (even when BUILD_DIR was correct variable), doesn't it?

Should I edit the patch that way or leave the file alone?

--

Timo

#3 lore raw

PATCH 1/1 doc: fix documentation of output directory

Hi Timo,

2014-11-05 17:12 GMT+09:00 Timo Ketola <[email protected]>:

Quoted 8 lines · Masahiro Yamada
Quoted 7 lines
Quoted 4 lines · On Tue, 4 Nov 2014 12:56:50 +0200 Timo Ketola <[email protected]> wrote:

make distclean
make yourboard_config

doc/README.kwbimage +1 -1
-  make $BUILD_DIR/u-boot.kwb
+  make $KBUILD_OUTPUT/u-boot.kwb
Quoted 9 lines
Quoted 3 lines

Should be
make yourboard_defconfig
make u-boot.kwb

Sounds logical. But that means that the older version was already broken (even when BUILD_DIR was correct variable), doesn't it?

Should I edit the patch that way or leave the file alone?

Both "make $BUILD_DIR/u-boot.kwb" and "make
"$KBUILD_OUTPUT/u-boot.kwb" are wrong.

"make u-boot.kwb" is correct.

Please fix the patch as I suggested.

Signature · 2 lines
Best Regards
Masahiro Yamada
#4 lore raw

PATCH v2 1/1 doc: fix documentation of out-of-tree build

Correct environment variable for output directory is KBUILD_OUTPUT.

---
v2 changes:
- Fixed the example in the doc/README.kwbimage file functionally correct

 README              |    6 +++---
 doc/README.kwbimage |    4 ++--
 2 files changed, 5 insertions(+), 5 deletions(-)
README +3 -3
index 7b5538e..c3a9dfc 100644
@@ -5012,14 +5012,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.
 
 
doc/README.kwbimage +2 -2
index 13f6f92..762b2e3 100644
@@ -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 u-boot.kwb
 
 
 Board specific configuration file specifications:
Signature · 1 line
1.7.9.5
#5 lore raw

PATCH v2 1/1 doc: fix documentation of out-of-tree build

Quoted 3 lines · Timo Ketola

Correct environment variable for output directory is KBUILD_OUTPUT.

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20141110/3fb40a14/attachment.pgp>