Add documentation on the latest build environment extentions to

the README file.

Add documentation on the latest build environment extentions to
the README file.
Marian Balakowicz
1 parent 5e09054af6
Showing 2 changed files with 39 additions and 0 deletions Side-by-side Diff
CHANGELOG
README
@@ -2,6 +2,9 @@
 Changes since U-Boot 1.1.4:
 ======================================================================
  
+* Add documentation on the latest build environment extentions to 
+  the README file.
+
 * Remove dead code (i2o and dma) from cpu/mpc824x/drivers/ directory.
  
 * Fix LOG_DIR directory creation error.
@@ -2323,7 +2323,27 @@
 - "u-boot" is an image in ELF binary format
 - "u-boot.srec" is in Motorola S-Record format
  
+By default the build is performed locally and the objects are saved
+in the source directory. One of the two methods can be used to change
+this behavior and build U-Boot to some external directory:
  
+1. Add O= to the make command line invocations:
+
+	make O=/tmp/build distclean
+	make O=/tmp/build NAME_config
+	make O=/tmp/build all
+
+2. Set environment variable BUILD_DIR to point to the desired location:
+
+	export BUILD_DIR=/tmp/build
+	make distclean
+	make NAME_config
+	make all
+
+Note that the command line "O=" setting overrides the BUILD_DIR environment
+variable.
+
+
 Please be aware that the Makefiles assume you are using GNU make, so
 for instance on NetBSD you might need to use "gmake" instead of
 native "make".
@@ -2375,6 +2395,22 @@
 or to build on a native PowerPC system you can type
  
 	CROSS_COMPILE=' ' MAKEALL
+
+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 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 MAKEALL_LOGDIR=/tmp/log
+	CROSS_COMPILE=ppc_8xx- MAKEALL
+
+With the above settings build objects are saved in the /tmp/build, log
+files are saved in the /tmp/log and the source tree remains clean during
+the whole build process.
+
  
 See also "U-Boot Porting Guide" below.
...	...	@@ -2,6 +2,9 @@
2	2	Changes since U-Boot 1.1.4:
3	3	======================================================================
4	4
	5	+* Add documentation on the latest build environment extentions to
	6	+ the README file.
	7	+
5	8	* Remove dead code (i2o and dma) from cpu/mpc824x/drivers/ directory.
6	9
7	10	* Fix LOG_DIR directory creation error.
...	...	@@ -2323,7 +2323,27 @@
2323	2323	- "u-boot" is an image in ELF binary format
2324	2324	- "u-boot.srec" is in Motorola S-Record format
2325	2325
	2326	+By default the build is performed locally and the objects are saved
	2327	+in the source directory. One of the two methods can be used to change
	2328	+this behavior and build U-Boot to some external directory:
2326	2329
	2330	+1. Add O= to the make command line invocations:
	2331	+
	2332	+ make O=/tmp/build distclean
	2333	+ make O=/tmp/build NAME_config
	2334	+ make O=/tmp/build all
	2335	+
	2336	+2. Set environment variable BUILD_DIR to point to the desired location:
	2337	+
	2338	+ export BUILD_DIR=/tmp/build
	2339	+ make distclean
	2340	+ make NAME_config
	2341	+ make all
	2342	+
	2343	+Note that the command line "O=" setting overrides the BUILD_DIR environment
	2344	+variable.
	2345	+
	2346	+
2327	2347	Please be aware that the Makefiles assume you are using GNU make, so
2328	2348	for instance on NetBSD you might need to use "gmake" instead of
2329	2349	native "make".
...	...	@@ -2375,6 +2395,22 @@
2375	2395	or to build on a native PowerPC system you can type
2376	2396
2377	2397	CROSS_COMPILE=' ' MAKEALL
	2398	+
	2399	+When using the MAKEALL script, the default behaviour is to build U-Boot
	2400	+in the source directory. This location can be changed by setting the
	2401	+BUILD_DIR environment variable. Also, for each target built, the MAKEALL
	2402	+script saves two log files (<target>.ERR and <target>.MAKEALL) in the
	2403	+<source dir>/LOG directory. This default location can be changed by
	2404	+setting the MAKEALL_LOGDIR environment variable. For example:
	2405	+
	2406	+ export BUILD_DIR=/tmp/build
	2407	+ export MAKEALL_LOGDIR=/tmp/log
	2408	+ CROSS_COMPILE=ppc_8xx- MAKEALL
	2409	+
	2410	+With the above settings build objects are saved in the /tmp/build, log
	2411	+files are saved in the /tmp/log and the source tree remains clean during
	2412	+the whole build process.
	2413	+
2378	2414
2379	2415	See also "U-Boot Porting Guide" below.
2380	2416