docs/development/dev-environment.md

1 # OpenBMC Development Environment
3 **Document Purpose:** How to set up an OpenBMC development environment
11 OpenBMC uses the [Yocto](https://www.yoctoproject.org/) Project as its
12 underlying building and distribution generation framework. The main OpenBMC
13 [README](https://github.com/openbmc/openbmc/blob/master/README.md) provides
14 information on getting up and going with Yocto and OpenBMC. This tutorial will
15 walk you through utilizing bitbake to build OpenBMC firmware and boot it in
18 Bitbake is the build engine used by Yocto and OpenBMC to build its custom Linux
20 OpenBMC images.
22 This doc walks through the recommended steps for setting up an OpenBMC
23 development environment, building OpenBMC, and running that image in QEMU.
33 The recommended OpenBMC development environment is the latest Ubuntu LTS
45    use this VM to BitBake a full OpenBMC image, you'll want to allocate as many
49    OpenBMC continuous integration utilizes docker to build its images. This is
51    [build-setup.sh](https://github.com/openbmc/openbmc-build-scripts/blob/master/build-setup.sh)
58    The majority of OpenBMC development community uses Ubuntu. The qemu below is
61    these are not tested nearly as much by the core OpenBMC team as Ubuntu.
72    [Prerequisite](https://github.com/openbmc/openbmc/blob/master/README.md#1-prerequisite)
78 ## Building OpenBMC
81 OpenBMC image. Future tutorials will build on this by having you customize the
82 image. If you would like to skip the building and just try out OpenBMC and QEMU
84 [OpenBMC Jenkins](https://jenkins.openbmc.org/job/latest-master/label=docker-builder,target=romulus…
88 1. Clone OpenBMC
91    git clone https://github.com/openbmc/openbmc.git
94 2. Build the Romulus OpenBMC Image (note this will take 30 - 120 minutes
108 1. Download latest openbmc/qemu fork of QEMU application
111 …wget https://jenkins.openbmc.org/job/latest-qemu-x86/lastSuccessfulBuild/artifact/qemu/build/qemu-…
156    the obmcutil tool to check the state of the OpenBMC state services. When you
160    root@openbmc:~# obmcutil state
178 You've now built an OpenBMC distribution and booted it in QEMU!
191 utilize it to customize your OpenBMC image.