From 11bf725453b2d61faee6a85fc184596ba2771556 Mon Sep 17 00:00:00 2001 From: Simon de Vlieger Date: Mon, 31 Mar 2025 12:51:35 +0200 Subject: [PATCH] doc: document `build --arch` Signed-off-by: Simon de Vlieger --- doc/01-usage.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/01-usage.md b/doc/01-usage.md index 869dc72..001efa6 100644 --- a/doc/01-usage.md +++ b/doc/01-usage.md @@ -112,6 +112,16 @@ $ sudo image-builder build --distro fedora-43 minimal-raw # ... progress ... ``` +When passed `--arch` `image-builder` will try to do an experimental cross-architecture build. Note that not all image types are available for all architectures. + +Cross-architecture builds are much slower than being able to build on native hardware. However, if no native hardware is available they might be an acceptable compromise. + +```console +$ sudo image-builder build --arch s390x qcow2 +WARNING: using experimental cross-architecture building to build "s390x" +# ... progress ... +``` + # Blueprints Images can be customized with [blueprints](https://osbuild.org/docs/user-guide/blueprint-reference). For example we could build the `qcow2` we built above with some customizations applied.