From 84ef1ec3811d5fb33d45c9a2dfbc1bb7a3a77fdf Mon Sep 17 00:00:00 2001 From: Geoffroy Van Cutsem Date: Tue, 28 Jun 2022 09:03:32 +0200 Subject: [PATCH] doc: add README.rst to misc/hv_prebuild Add a basic README.rst to the misc/hv_prebuild folder to give a brief explanation as to what is in there and to help users navigating to that folder determine if they should care or not. Tracked-On: #5580 Signed-off-by: Geoffroy Van Cutsem --- misc/hv_prebuild/README.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 misc/hv_prebuild/README.rst diff --git a/misc/hv_prebuild/README.rst b/misc/hv_prebuild/README.rst new file mode 100644 index 000000000..7b564d476 --- /dev/null +++ b/misc/hv_prebuild/README.rst @@ -0,0 +1,14 @@ +:orphan: + +Hypervisor Pre-Build Check Tool +############################### + +There are a number of configuration elements for the ACRN hypervisor that must +defined before building the binaries. Those configuration elements are set +by the user using the :ref:`ACRN Configurator tool `. + + +This folder holds the source to a tool that is used to ensure that the +configuration is coherent and valid. It is a tool used in the background by +the build system before compiling the hypervisor and other components. It is +not meant to be used as a stand-alone too.