diskimage-builder/elements/baremetal/README.rst
Antoine Musso 8d052a54a7 Turn docs warnings into errors and fix issues
Set the pbr option 'warnerrors' to make build_sphinx turns warnings into
error. Fix all warnings.

`tox -edocs` will thus abort whenever someone introduce a new error.

Change-Id: Id6d09768a241866e1fdc1a1e2bf90336f5c5087d
2015-04-27 15:03:19 +00:00

20 lines
512 B
ReStructuredText

.. _element-baremetal:
=========
baremetal
=========
This is the baremetal (IE: real hardware) element.
Does the following:
* extracts the kernel and initial ramdisk of the built image.
Optional parameters:
* DIB_BAREMETAL_KERNEL_PATTERN and DIB_BAREMETAL_INITRD_PATTERN
may be supplied to specify which kernel files are preferred; this
can be of use when using custom kernels that don't fit the
standard naming patterns. Both variables must be provided in
order for them to have any effect.