diff options
author | Jürg Billeter <j@bitron.ch> | 2018-02-07 11:24:34 +0100 |
---|---|---|
committer | Jürg Billeter <j@bitron.ch> | 2018-02-07 11:24:34 +0100 |
commit | fc384201bb8ab6254ca9be6e1e897fb38f3be0b1 (patch) | |
tree | 36ab1fbb207020dbe73d9fb9ab13c8731ba44413 /doc | |
parent | 34a60189be63dc86d333ca895ce44bd24adb43c3 (diff) | |
download | buildstream-fc384201bb8ab6254ca9be6e1e897fb38f3be0b1.tar.gz |
Revert "image_authoring.rst: Add image creation documentation"
This was pushed accidentally.
This reverts commit 34a60189be63dc86d333ca895ce44bd24adb43c3.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/image_authoring.rst | 69 |
1 files changed, 0 insertions, 69 deletions
diff --git a/doc/source/image_authoring.rst b/doc/source/image_authoring.rst deleted file mode 100644 index e7a93e8fb..000000000 --- a/doc/source/image_authoring.rst +++ /dev/null @@ -1,69 +0,0 @@ -.. _image_authoring: - -Authoring System Images -======================= -This section forms a guide to creating system images with BuildStream. - -Building a Linux image ----------------------- - -Setting up the project -~~~~~~~~~~~~~~~~~~~~~~ - -To create an image, we will want to use the x86image plugin from the -``bst-external`` repository. The ``bst-external`` repository is a -collection of plugins that are either too niche or unpolished to -include as plugins in the main repository, but are useful for various -purposes. - -If you have not already, install the latest version of this -repository: - - git clone https://gitlab.com/BuildStream/bst-external.git - cd bst-external - pip3 install . - -This should make bst-external plugins available to buildstream. To use -the x86image and docker plugins in our project, we need to set up -plugins in our =project.conf=: - -#+INCLUDE: "./project.conf" example yaml :lines "-17" - -We also set aliases for all project pages we will be fetching sources -from, should we later want to change their location (e.g. when we -decide that we want to mirror the files in our datacenter for -performance reasons): - -#+INCLUDE: "./project.conf" example yaml :lines "17-" - -Base System -~~~~~~~~~~~ - -The base system will be used to *build* the image and the project, but -it won't be a part of the final result. It should contain everything -that is required to build both the project and the tools required to -create an image. - -The x86image plugin requires a specific set of tools to create an -image. To make using this plugin easier, we provide an alpine-based -base system using docker that contains all required tools: - -#+INCLUDE: "./elements/base.bst" example yaml - -This image only provides musl-libc and busybox for building, should -your project require GNU tools it will be simpler to create your own -and ensure that your base system includes the following packages: - -* parted -* mtools -* e2fsprogs -* dosfstools -* syslinux -* nasm -* autoconf -* gcc -* g++ -* make -* gawk -* bc -* linux-headers |