diff mbox series

[08/11] dev-manual/wic.rst: add a requirement to use wic from the build system

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

Commit Message

Antonin Godard June 25, 2026, 9:33 a.m. UTC 
Since wic is no longer part of OE-Core since [1], we have to use wic
from the build system instead, which can be done by following few steps,
finally creating an alias, so that the commands from this document
remain valid.

[1]: https://git.openembedded.org/openembedded-core/commit/?id=25ca1cb46dd6d0c57f61f2dc3b649601dc81b50c

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

Patch

diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst
index 5fc7759f8..980f5197c 100644
--- a/documentation/dev-manual/wic.rst
+++ b/documentation/dev-manual/wic.rst
@@ -75,6 +75,29 @@  system needs to meet the following requirements:
    going to run ``bitbake`` commands. See :ref:`dev-manual/start:Initializing
    the Build Environment` for more details.
 
+-  Make the ``wic`` command-line tool available in your shell:
+
+   #. Run the following command first:
+
+      .. code-block:: console
+
+         $ bitbake wic-native -c addto_recipe_sysroot
+
+   #. Check if you can use the ``wic`` utility using ``oe-run-native``:
+
+      .. code-block:: console
+
+         $ oe-run-native wic-native wic --help
+
+   #. Define a local alias for the above command:
+
+      .. code-block:: console
+
+         $ alias wic="oe-run-native wic-native wic"
+
+      This will make it possible to use ``wic`` from the :term:`OpenEmbedded
+      Build System` transparently below.
+
 -  You need to have the build artifacts already available, which
    typically means that you must have already created an image using the
    OpenEmbedded build system (e.g. ``core-image-minimal``). While it