doc: updated barebox documentation

4d0822d0 · Alessandro Rubini · 5b1a173a · 4d0822d0
Commit 4d0822d0 authored Aug 02, 2012 by Alessandro Rubini
Hide whitespace changes
Inline Side-by-side

Showing with 28 additions and 17 deletions

wrs-build.in doc/wrs-build.in +28 -17

No files found.
--- a/doc/wrs-build.in
+++ b/doc/wrs-build.in
@@ -904,8 +904,9 @@ For simplicity, a known-working binary is part of the @i{binaries}
 directory of this package as @code{at91bootstrap.bin}, the same name used
 later in the installation instructions.

-If you build using a local @i{git} repository, please ignore the copious
-messages about white space error in this patch set, we apologize for that.
+If you build using a local @i{git} repository, we suggest to use
+@code{git am --whitespace=nowarn} because we have a number of
+white space errors, and we apologize for that.

 @b{Warning}: with most distributions, this compilation step will print
 a scary message about memory corruption. The message is reporting a bug in
@@ -918,27 +919,29 @@ the bug, or to the newer @i{barebox} that obsoletes @i{at91boot}.
 @chapter The Boot Loader

 The switch uses @i{barebox} as a boot loader. We are running version
-2012-05, with one simple local patch and the chosen configuration
-file. More patches will be needed to customize board names (we are
-piggy-backing on the Ronetix PM9G45 board).
+2012-05, with a few local patches and the chosen configuration
+file. Note that we are piggy-backing on the Ronetix PM9G45 board, out
+of laziness.

 The patches are part of this package in @i{patches/barebox} and
-are currently the following ones:
+the set is made up of the following ones:

 @smallexample
-    0001-sam945-include-mtd-nand.h-in-device-file.patch
-	0002-arm-config-added-wrs3_defconfig-and-fixed-default-at.patch
-	0003-nand-wrs-it-s-16-bits-not-8.patch
-	0004-add-DHCP-retries-by-tom.patch
-	0005-build-Add-a-script-to-compile-with-WRS-env-variables.patch
-	0006-gpio-add-function-to-check-them.patch
-	0007-startup-load-default-environment-when-loading-env-fa.patch
-	0008-nand-Fix-wrongly-removed-line-for-16bits-NAND.patch
-	0009-wrs-init-config-script-with-menu-support-v3.2.patch
-	0001-91samg45-removed-two-clock-that-failed-compilation.patch
+   0001-sam945-include-mtd-nand.h-in-device-file.patch
+   0002-arm-config-added-wrs3_defconfig-and-fixed-default-at.patch
+   0003-nand-wrs-it-s-16-bits-not-8.patch
+   0004-add-DHCP-retries-by-tom.patch
+   0005-gpio-add-function-to-check-them.patch
+   0006-startup-load-default-environment-when-loading-env-fa.patch
+   0007-nand-Fix-wrongly-removed-line-for-16bits-NAND.patch
+   0008-wrs-init-config-script-with-menu-support-v3.2.patch
 @end smallexample

-The build scripts compile with the following commands, where the
+If you build using a local @i{git} repository, we suggest to use
+@code{git am --whitespace=nowarn} because we have a number of
+white space errors, and we apologize for that.
+
+After patching, the build scripts compile with the following commands, where the
 cross-compiler is the one built by @i{buildroot}. If you run these
 by hand you can use a different compiler (as shown):

@@ -950,6 +953,14 @@ by hand you can use a different compiler (as shown):
   cp barebox.bin /tftpboot/bb.bin
 @end example

+To use the compiler the scripts use, you need this setting (which is split
+in two lines with a local variable to fit the page with in documentation):
+
+@smallexample
+   BR=${WRS_OUTPUT_DIR}/build/buildroot-2011.11
+   export CROSS_COMPILE=${BR}/output/host/usr/bin/arm-linux-
+@end smallexample
+
 A pre-built binary is available as @code{binaries/barebox.bin}.

 The ELF version is copied to @i{images} as well, as