Add optional build configuration section

Signed-off-by: Andrei Gherzan <andrei@gherzan.ro>

1 files changed, 79 insertions, 71 deletions

diff --git a/README b/README
index 0a8031d..5798e61 100644
--- a/README
+++ b/README
@@ -12,28 +12,30 @@ Contents:
 =========
 1. Description
 2. Yocto BSP Layer - Raspberry Pi
-    2.A. Compressed deployed files
-    2.B. GPU memory
-    2.C. Add purchased license codecs
-    2.D. Disable overscan
-    2.E. Set overclocking options
-    2.F. Optional - Video camera support with V4L2 drivers
-    2.G. Optional - Enable offline compositing support
-    2.H. Optional - Enable kgdb over console support
-    2.I. Images
-    2.J. Boot to U-Boot
-    2.K. Image with Initramfs
-    2.L. Device tree support
-    2.M. Optional - enable SPI bus
-3. Extra apps
-    3.A. omxplayer
-4. Board Configuration
-    4.A. Audio Routing
-5. Source code and mirrors
-6. Contribution
-    5.A. Mailing List
-    5.B. Redmine
-7. Maintainers
+    2.A. How to use it
+    2.B. Images
+3. Optional build configuration
+    3.A. Compressed deployed files
+    3.B. GPU memory
+    3.C. Add purchased license codecs
+    3.D. Disable overscan
+    3.E. Set overclocking options
+    3.F. Video camera support with V4L2 drivers
+    3.G. Enable offline compositing support
+    3.H. Enable kgdb over console support
+    3.I. Boot to U-Boot
+    3.J. Image with Initramfs
+    3.K. Device tree support
+    3.L. Enable SPI bus
+4. Extra apps
+    4.A. omxplayer
+5. Board Configuration
+    5.A. Audio Routing
+6. Source code and mirrors
+7. Contribution
+    7.A. Mailing List
+    7.B. Redmine
+8. Maintainers
 
 
 1. Description
@@ -64,18 +66,35 @@ layers: meta-oe, meta-multimedia
 branch: master
 revision: HEAD
 
-How to use it:
-
-1. source poky/oe-init-build-env rpi-build
-2. Add needed layer to bblayers.conf:
+2.A. How to use it
+==================
+a. source poky/oe-init-build-env rpi-build
+b. Add needed layer to bblayers.conf:
     - meta-raspberrypi
-3  Set MACHINE to "raspberrypi"/"raspberrypi2" in local.conf
-4. bitbake rpi-hwup-image
-5. dd to a SD card the generated sdimg file (use xzcat if rpi-sdimg.xz is used)
-6. Boot your RPI.
+c. Set MACHINE to "raspberrypi"/"raspberrypi2" in local.conf
+d. bitbake rpi-hwup-image
+e. dd to a SD card the generated sdimg file (use xzcat if rpi-sdimg.xz is used)
+f. Boot your RPI.
+
+2.B. Images
+-===========
+* rpi-hwup-image
+    Hardware up image
+* rpi-basic-image
+    Based on rpi-hwup-image with some added features (ex: splash)
+* rpi-test-image
+    Image based on rpi-basic-image which includes most of the packages in this
+    layer and some media samples.
+
+3. Optional build configuration
+===============================
 
-2.A. Optional - compressed deployed files:
-==========================================
+There are a set of ways in which a user can influence different paramenters of the build.
+We list here the ones that are closely related to this BSP or specific to it. For the rest
+please check: http://www.yoctoproject.org/docs/latest/ref-manual/ref-manual.html
+
+3.A. Compressed deployed files
+==============================
 1. Overwrite IMAGE_FSTYPES in local.conf
     IMAGE_FSTYPES = "tar.bz2 ext3.xz"
 2. Overwrite SDIMG_ROOTFS_TYPE in local.conf
@@ -84,8 +103,8 @@ How to use it:
     SDIMG_COMPRESSION = "xz"
 *Accommodate the values above to your own needs (ex: ext3 / ext4).
 
-2.B. Optional - GPU memory:
-===========================
+3.B. GPU memory
+===============
 Variable    : Details
 GPU_MEM     : GPU memory in megabyte. Sets the memory split between the ARM and
               GPU. ARM gets the remaining memory. Min 16. Default 64.
@@ -96,8 +115,8 @@ GPU_MEM_512 : GPU memory in megabyte for the 512MB Raspberry Pi. Ignored by the
 GPU_MEM_1024: GPU memory in megabyte for the 1024MB Raspberry Pi. Ignored by the
               256MB/512MB RP. Overrides gpu_mem. Max 944. Default not set.
 
-2.C.Optional - Add purchased license codecs:
-============================================
+3.C. Add purchased license codecs
+=================================
 To add you own licenses use variables KEY_DECODE_MPG2 and KEY_DECODE_WVC1 in
 local.conf. Example:
 KEY_DECODE_MPG2 = "12345678"
@@ -105,15 +124,15 @@ KEY_DECODE_WVC1 = "12345678"
 You can supply more licenses separated by comma. Example:
 KEY_DECODE_WVC1 = "0x12345678,0xabcdabcd,0x87654321"
 
-2.D. Optional - Disable overscan:
-=================================
+3.D. Disable overscan
+=====================
 By default the GPU adds a black border around the video output to compensate for
 TVs which cut off part of the image. To disable this set this variable in
 local.conf:
 DISABLE_OVERSCAN = "1"
 
-2.E. Optional - Set overclocking options:
-=========================================
+3.E. Set overclocking options
+=============================
 The Raspberry PI can be overclocked. As of now overclocking up to the "Turbo
 Mode" is officially supported by the raspbery and does not void warranty.
 Check the config.txt for a detailed description of options and modes. Example:
@@ -123,14 +142,13 @@ CORE_FREQ = "500"
 SDRAM_FREQ = "500"
 OVER_VOLTAGE = "6"
 
-2.F. Optional - Video camera support with V4L2 drivers
-======================================================
+3.F. Video camera support with V4L2 drivers
+===========================================
 Set this variable to enable support for the video camera (Linux 3.12.4+ required)
 VIDEO_CAMERA = "1"
 
-2.G. Optional - Enable offline compositing support
-==================================================
-
+3.G. Enable offline compositing support
+=======================================
 Set this variable to enable support for dispmanx offline compositing
 DISMANX_OFFLINE = "1"
 
@@ -144,23 +162,13 @@ Heavily recommended for Wayland/Weston.
 
 See: http://wayland.freedesktop.org/raspberrypi.html
 
-2.H. Optional - Enable kgdb over console support
-================================================
+3.H. Enable kgdb over console support
+=====================================
 To add the kdbg over console (kgdboc) parameter to the kernel command line,
 set this variable in local.conf:
 ENABLE_KGDB = "1"
 
-2.I. Images
-===========
-* rpi-hwup-image
-    Hardware up image
-* rpi-basic-image
-    Based on rpi-hwup-image with some added features (ex: splash)
-* rpi-test-image
-    Image based on rpi-basic-image which includes most of the packages in this
-    layer and some media samples.
-
-2.J. Boot to U-Boot
+3.I. Boot to U-Boot
 ===================
 To have u-boot load kernel image, set in your local.conf
 KERNEL_IMAGETYPE = "uImage"
@@ -168,7 +176,7 @@ KERNEL_IMAGETYPE = "uImage"
 This will make kernel.img be u-boot image which will load uImage.
 By default, kernel.img is the actual kernel image (ex. Image).
 
-2.K. Image with Initramfs
+3.J. Image with Initramfs
 =========================
 To build an initramfs image :
     * Set this 3 kernel variables (in linux-raspberrypi.inc for example)
@@ -181,7 +189,7 @@ To build an initramfs image :
     * Set the meta-rasberrypi variable (in raspberrypi.conf for example)
         - KERNEL_INITRAMFS = "-initramfs"
 
-2.L. Device tree support
+3.K. Device tree support
 =========================
 Device tree for RPi is only supported when using linux-raspberrypi 3.18+
 kernels.
@@ -194,25 +202,25 @@ kernels.
 NOTE: KERNEL_DEVICETREE is default enabled for kernel >= 3.18 and always disabled for
       older kernel versions.
 
-2.M. Optional - enable SPI bus
-==============================
+3.L. Eenable SPI bus
+====================
 When using device tree kernels, set this variable to enable the SPI bus
 ENABLE_SPI_BUS = "1"
 
-3. Extra apps
+4. Extra apps
 =============
 
-3.A. omxplayer
+4.A. omxplayer
 ==============
 omxplayer depends on libav which has a commercial license. So in order to be
 able to compile omxplayer you will need to whiteflag the commercial license
 adding to you local.conf:
 LICENSE_FLAGS_WHITELIST = "commercial"
 
-4. Board Configuration
+5. Board Configuration
 ======================
 
-4.A. Audio Routing
+5.A. Audio Routing
 ==================
 To load audio driver
 
@@ -236,7 +244,7 @@ Options to amixer cset are:
     1=headphones
     2=hdmi
 
-5. Source code and mirrors
+6. Source code and mirrors
 ==========================
 
 Main repo:
@@ -250,10 +258,10 @@ Bitbucket mirror:
     https://bitbucket.org/agherzan/meta-raspberrypi
 
 
-6. Contributing
+7. Contributing
 ===============
 
-6.A. Mailing list
+7.A. Mailing list
 =================
 The main communication tool we use is a mailing list:
     yocto@yoctoproject.org
@@ -277,7 +285,7 @@ When sending patches to mailing list, please use something like:
 
     git send-email --to yocto@yoctoproject.org <generated patch>
 
-6.B. Redmine
+7.B. Redmine
 ============
 In order to manage and trace the meta-raspberrypi issues, we use redmine:
     http://redmine.gherzan.ro/projects/meta-raspberrypi
@@ -291,7 +299,7 @@ for a bug:
     [Bug #13]
 
 
-7. Maintainers
+8. Maintainers
 ==============
 
     Andrei Gherzan <andrei at gherzan.ro>