From 6f7ba36ea0f250b183cf330d62c909f194b23d64 Mon Sep 17 00:00:00 2001 From: Geoffroy Van Cutsem Date: Thu, 3 Oct 2019 08:33:54 +0200 Subject: [PATCH] doc: move the "Building ACRN in Docker" user guide Move the "Building ACRN in Docker" guide to the "Try using ACRN" section to be more prominently visible. Reference it from the main "Build ACRN from Source" user guide. Signed-off-by: Geoffroy Van Cutsem --- doc/develop.rst | 1 - doc/{tutorials => getting-started}/Dockerfile | 0 doc/getting-started/building-from-source.rst | 5 ++++- .../building_acrn_in_docker.rst | 2 +- doc/try.rst | 1 + 5 files changed, 6 insertions(+), 3 deletions(-) rename doc/{tutorials => getting-started}/Dockerfile (100%) rename doc/{tutorials => getting-started}/building_acrn_in_docker.rst (98%) diff --git a/doc/develop.rst b/doc/develop.rst index d5599b1a4..efe6fc0af 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -26,7 +26,6 @@ Configuration Tutorials tutorials/using_partition_mode_on_up2 tutorials/using_sdc2_mode_on_nuc tutorials/using_hybrid_mode_on_nuc - tutorials/building_acrn_in_docker tutorials/realtime_performance_tuning User VM Tutorials diff --git a/doc/tutorials/Dockerfile b/doc/getting-started/Dockerfile similarity index 100% rename from doc/tutorials/Dockerfile rename to doc/getting-started/Dockerfile diff --git a/doc/getting-started/building-from-source.rst b/doc/getting-started/building-from-source.rst index b7037ec74..81755ff5c 100644 --- a/doc/getting-started/building-from-source.rst +++ b/doc/getting-started/building-from-source.rst @@ -52,7 +52,10 @@ Step 1: Install build tools and dependencies ******************************************** ACRN development is supported on popular Linux distributions, each with -their own way to install development tools: +their own way to install development tools. This user guide covers the different +steps to configure and build ACRN natively on your distribution. Please refer to +the :ref:`building-acrn-in-docker` user guide for instructions on how to build +ACRN using a container. .. note:: ACRN uses ``menuconfig``, a python3 text-based user interface (TUI) for diff --git a/doc/tutorials/building_acrn_in_docker.rst b/doc/getting-started/building_acrn_in_docker.rst similarity index 98% rename from doc/tutorials/building_acrn_in_docker.rst rename to doc/getting-started/building_acrn_in_docker.rst index 8e14b6c58..89d6ef11c 100644 --- a/doc/tutorials/building_acrn_in_docker.rst +++ b/doc/getting-started/building_acrn_in_docker.rst @@ -32,7 +32,7 @@ This tutorial presents two ways to get the Clear Linux Docker image that's neede Build the Docker Image from Dockerfile ====================================== -#. Download `Dockerfile `_ +#. Download `Dockerfile `_ to your development machine. #. Build the Docker image: diff --git a/doc/try.rst b/doc/try.rst index 6126a9048..d2cb45999 100644 --- a/doc/try.rst +++ b/doc/try.rst @@ -24,4 +24,5 @@ Follow these getting started guides to give ACRN a try: getting-started/up2 getting-started/acrn_ootb getting-started/building-from-source + getting-started/building_acrn_in_docker getting-started/rt_industry