diff mbox series

[11/11] ref-manual/kickstart.rst: document the include directive

Message ID 20260625-wic-migration-v1-11-fef8d481aecc@bootlin.com
State New
Headers show
Series Migrate WIC documentation | expand

Commit Message

Antonin Godard June 25, 2026, 9:33 a.m. UTC 
Including WKS files into others can be useful to avoid duplicating code
for similar images. Add documentation for it.

The example was taken from the meta/files/wic/directdisk-bootloader-config.wks
file in OE-Core.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/kickstart.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
index 692ee2de0..e7cba555a 100644
--- a/documentation/ref-manual/kickstart.rst
+++ b/documentation/ref-manual/kickstart.rst
@@ -232,3 +232,15 @@  supports the following options:
 -  ``--timeout``: Specifies the number of seconds before the
    bootloader times out and boots the default option.
 
+Directive: include
+==================
+
+The ``include`` directive can be used to include a WKS file into another. The
+only argument to this command is the path to the file to include, relative to
+the current file. For example:
+
+.. code-block:: shell
+
+   include common.wks.inc
+
+   bootloader --configfile="directdisk-bootloader-config.cfg"