aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuillaume Tucker <guillaume.tucker@collabora.com>2018-08-14 08:41:48 +0100
committerNeil Williams <neil.williams@linaro.org>2018-08-28 08:29:26 +0000
commit2d373d36a4a6636831e7b676206568a95ec4f976 (patch)
treeb6c7fbb847efc05b2b97d3790e358df214c693ab
parentcc432d33b5e0a4092e7804e6d0c2b33aa9904b93 (diff)
documentation: add note about no kernel type attribute for Depthcharge
Unlike with `u-boot', there should not be any `type' kernel attribute in the `deploy' stage when using the `depthcharge' boot method. Add a note in the documentation about this. Change-Id: I8dd1d7c8026e6ac864daaad0d75e29c36c9d43e7 Signed-off-by: Guillaume Tucker <guillaume.tucker@collabora.com>
-rw-r--r--doc/v2/actions-boot.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/v2/actions-boot.rst b/doc/v2/actions-boot.rst
index dec5b8187..32a14cd36 100644
--- a/doc/v2/actions-boot.rst
+++ b/doc/v2/actions-boot.rst
@@ -382,6 +382,21 @@ alongside the FIT image.
method: depthcharge
commands: nfs
+.. note:: Unlike some other boot methods such as ``u-boot``, the
+ ``depthcharge`` boot method always expects the kernel image to be in
+ the same standard format (zImage for arm, Image for arm64...). So
+ there should not be any ``type`` attribute for the kernel image in
+ the ``deploy`` section as shown in the example below:
+
+.. code-block:: yaml
+
+ - deploy:
+ kernel:
+ url: http://storage.kernelci.org/mainline/master/v4.18-1283-g10f3e23f07cb/arm/multi_v7_defconfig/zImage
+ ramdisk:
+ url: http://storage.kernelci.org/images/rootfs/debian/stretchtests/20180627.0/armhf/rootfs.cpio.gz
+ compression: gz
+
.. index:: boot method fastboot
.. _boot_method_fastboot: