OSDN Git Service

docs: Add caveats for Windows as the build platform
authorBin Meng <bin.meng@windriver.com>
Tue, 19 Jul 2022 13:50:14 +0000 (21:50 +0800)
committerPaolo Bonzini <pbonzini@redhat.com>
Fri, 22 Jul 2022 17:01:44 +0000 (19:01 +0200)
commitb67de91e0d4cae883a038f31b2207a1aaef5e51c
tree2c076bd43ef8f7268522559d1f691dd4540edd39
parent5288bee45fbd33203b61f8c76e41b15bb5913e6e
docs: Add caveats for Windows as the build platform

Commit cf60ccc3306c ("cutils: Introduce bundle mechanism") introduced
a Python script to populate a bundle directory using os.symlink() to
point to the binaries in the pc-bios directory of the source tree.
Commit 882084a04ae9 ("datadir: Use bundle mechanism") removed previous
logic in pc-bios/meson.build to create a link/copy of pc-bios binaries
in the build tree so os.symlink() is the way to go.

However os.symlink() may fail [1] on Windows if an unprivileged Windows
user started the QEMU build process, which results in QEMU executables
generated in the build tree not able to load the default BIOS/firmware
images due to symbolic links not present in the bundle directory.

This commits updates the documentation by adding such caveats for users
who want to build QEMU on the Windows platform.

[1] https://docs.python.org/3/library/os.html#os.symlink

Signed-off-by: Bin Meng <bin.meng@windriver.com>
Reviewed-by: Stefan Weil <sw@weilnetz.de>
Reviewed-by: Akihiko Odaki <akihiko.odaki@gmail.com>
Message-Id: <20220719135014.764981-1-bmeng.cn@gmail.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
docs/about/build-platforms.rst