Skip to content

Commit

Permalink
[doc] Document expected environment for dib
Browse files Browse the repository at this point in the history
diskimage-builder, or at least the most common elements, have
always had an implicit requirement to be run code intended for a
linux machine on the targeted architecture. This documents that
requirement up-front so users won't attempt in vain to build
cross-architecture or use it unix-like systems like Mac OS.

Change-Id: I22be1f9c929054c8ddc3253f55fa310bee29c055
  • Loading branch information
jayofdoom committed Feb 21, 2025
1 parent 673e4d4 commit ce72487
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/source/user_guide/building_an_image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Building An Image
Now that you have diskimage-builder properly :doc:`installed <installation>`
you can get started by building your first disk image.

.. note:: diskimage-builder requires a linux machine able to mount filesystems
and execute code for the target CPU architecture of the image. (e.g.;
building an ARM image requires a linux machine that can run ARM code).

VM Image
--------

Expand Down

0 comments on commit ce72487

Please sign in to comment.