path: root/BUILD.md
diff options
authorArsalan H. Awan <Arsalan_Awan@mentor.com>2019-09-09 14:34:14 +0500
committerArsalan H. Awan <Arsalan_Awan@mentor.com>2019-09-15 17:21:07 +0500
commita341921e7cfc02758c71c7e055e86e7c51fbb88d (patch)
tree9b7bfc552fbfd14617bde337ec10c514d40f496b /BUILD.md
parenta830cd7664edc727cb0b9fe8c61871558ad68c19 (diff)
meta-amd/docs: add setup, build, deploy & customize instructions
This adds a Getting Started Guide in the form of README docs to the meta-amd. Users can follow these instructions to: 1. Setup the build system 2. Build images and recipes for a supported target 3. Deploy the built image to a target machine 4. Customize the image by enabling or disabling certain configurable features and software components Signed-off-by: Arsalan H. Awan <Arsalan_Awan@mentor.com>
Diffstat (limited to 'BUILD.md')
1 files changed, 64 insertions, 0 deletions
diff --git a/BUILD.md b/BUILD.md
new file mode 100644
index 00000000..0c9ce2e0
--- /dev/null
+++ b/BUILD.md
@@ -0,0 +1,64 @@
+# 2. Setting up and starting a build
+After [setting up the build system](SETUP.md), we can build images or
+recipes for a target machine (or BSP).
+Running the commands in the instructions below will setup a build for
+a selected AMD BSP, and start a build:
+### 2.1. Select a BSP
+Set the environment variable `MACHINE` to one of the
+[supported AMD BSPs](meta-amd-bsp/README.md) (change the
+`<machine-name>` in the following example accordingly):
+### 2.2. Setup the build environment for selected BSP
+Source the *oe-init-build-env* script:
+source ./oe-init-build-env build-${MACHINE}-warrior
+Set the `MACHINE` and `DISTRO` bitbake environment variables in the
+`conf/local.conf` (or `auto.conf`):
+tee conf/auto.conf <<EOF
+DL_DIR ?= "\${TOPDIR}/../downloads"
+SSTATE_DIR ?= "\${TOPDIR}/../sstate-cache"
+DISTRO = "poky-amd"
+Add the required layers to the build configuration:
+bitbake-layers add-layer ../meta-openembedded/meta-oe
+bitbake-layers add-layer ../meta-openembedded/meta-python
+bitbake-layers add-layer ../meta-openembedded/meta-networking
+bitbake-layers add-layer ../meta-dpdk
+bitbake-layers add-layer ../meta-amd/meta-amd-distro
+bitbake-layers add-layer ../meta-amd/meta-amd-bsp
+### 2.3. Start the build
+Build one of the supported image recipes:
+bitbake <image-name> -k
+###### where `<image-name>` is to be replaced with one of the supported images for the selected AMD BSP.
+###### (e.g. `core-image-sato` or `core-image-base`)
+#### What's next
+Continue to "[section 3 - deploy](DEPLOY.md)" for instructions on
+booting the target with the newly built image.
+You can also [customize the image](CUSTOMIZE.md) by enabling/disabling
+certain configurable features. Make sure to re-build the image before
+deploying the customized build.