diskimage-builder

History

Andreas Florath fdd2c4b236 Semi-automatic doc generation of element dependency Currently there is no description of dependencies in the generated documentation of the elements: therefore a user of an element does not know which other elements are automatically included and e.g. which configuration options are available. In addition there are some copy&pastes of parts of the README.rst scattered thought different Ubuntu and Debian specific elements. This patch adds a semi-automatic generation of dependency information of all elements. Nevertheless these are not automatically included. The author of the element's README.rst can decide if and where the dependency information should appear and can use the descriptor .. element_deps:: for this. This patch adds the dependency information for some Debian and Ubuntu patches - and creates the base for later removing the duplicated parts. A call is added to element_dependencies._find_all_elements() to populate reverse dependencies for Element objects. (This is a reworking of I31d2b6050b6c46fefe37378698e9a330025db430 for the feature/v2 branch) Change-Id: Iebb83916fed71565071246baa550849eef40560b		2017-02-09 09:50:30 +11:00
..
environment.d	Move elements & lib relative to diskimage_builder package	2016-11-01 17:27:41 -07:00
install.d	Release 1.27.0	2017-02-03 11:49:45 +11:00
root.d	Release 1.24.0	2017-01-31 14:14:19 +11:00
element-deps	Move elements & lib relative to diskimage_builder package	2016-11-01 17:27:41 -07:00
package-installs.yaml	Move elements & lib relative to diskimage_builder package	2016-11-01 17:27:41 -07:00
pkg-map	Move elements & lib relative to diskimage_builder package	2016-11-01 17:27:41 -07:00
README.rst	Semi-automatic doc generation of element dependency	2017-02-09 09:50:30 +11:00

README.rst

===========
debootstrap
===========

Base element for creating minimal debian-based images.

This element is incomplete by itself, you'll want to use the debian-minimal
or ubuntu-minimal elements to get an actual base image.

If necessary, a custom apt keyring and debootstrap script can be
supplied to the `debootstrap` command via `DIB_APT_KEYRING` and
`DIB_DEBIAN_DEBOOTSTRAP_SCRIPT` respectively. Both options require the
use of absolute rather than relative paths.

Use of this element will also require the tool 'debootstrap' to be
available on your system. It should be available on Ubuntu, Debian,
and Fedora.

The `DIB_OFFLINE` or more specific `DIB_DEBIAN_USE_DEBOOTSTRAP_CACHE`
variables can be set to prefer the use of a pre-cached root filesystem
tarball. Setting `DIB_OFFLINE` may cause other element to use cached data,
while `DIB_DEBIAN_USE_DEBOOTSTRAP_CACHE` only functions in the debootstrap
element.

The `DIB_DEBOOTSTRAP_EXTRA_ARGS` environment variable may be used to
pass extra arguments to the debootstrap command used to create the
base filesystem image. If --keyring is is used in `DIB_DEBOOTSTRAP_EXTRA_ARGS`,
it will override `DIB_APT_KEYRING` if that is used as well.

The `DIB_DEBOOTSTRAP_CACHE` variable can be used to cache the created root
filesystem. By default this is 0 (disabled) and any other value enables this.
If run in offline mode then the most recently cached rootfs is used instead of
being built.

The `DIB_DEBOOTSTRAP_DEFAULT_LOCALE` environment variable may be used
to configure the default locale of the base image. It defaults to
C.UTF-8.

-------------------
Note on ARM systems
-------------------

Because there is not a one-to-one mapping of `ARCH` to a kernel package, if
you are building an image for ARM on debian, you need to specify which kernel
you want in the environment variable `DIB_ARM_KERNEL`. For instance, if you want
the `linux-image-mx5` package installed, set `DIB_ARM_KERNEL` to `mx5`.

.. element_deps::