From patchwork Thu Jan 26 11:22:34 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 647118 Delivered-To: patch@linaro.org Received: by 2002:a17:522:b9de:b0:4b9:b062:db3b with SMTP id fj30csp188913pvb; Thu, 26 Jan 2023 03:32:29 -0800 (PST) X-Google-Smtp-Source: AMrXdXu5N8Q63uclffdGoYmCNLu3JadtCiIPIclHYU6gi1KuNRsZmXgjyf4eAn2cHq/V18Jz2S+M X-Received: by 2002:ad4:5c46:0:b0:536:ba5e:6a8d with SMTP id a6-20020ad45c46000000b00536ba5e6a8dmr45328540qva.22.1674732749669; Thu, 26 Jan 2023 03:32:29 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1674732749; cv=none; d=google.com; s=arc-20160816; b=d54tBiQ5OXpO28jF08eVK+730jjjBtstGfD7SC6n6nYzc9AxR49nf3pSeqMaCZ2bgF oEaqgwTNonzSARTvnhM8UdF3jjOqwtn95Ninx+v2SlC+atMw1ltZLyoUqFHuroT9UHJy 6cS6RzOmh1cPMkpcgSTg6OoyMNNZEh9FkK4YTP+CWltAFsIJB7ROp64UHfgJt5iRnkbv 8Mb90f6qyfXOnHf6IuG7REEi4kYLZwIaAp2fHKY+vM3kVJL6wXaHxsPkS8GflPCb6oO/ EHN30wWo5lWHTqWRB8S6BI17SFFKz9HhPV0tXNyCVCXGB9TttOJHwnXvtBBKADfSX1ZK 3R/g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=y/TiS+4tqDBwIwjrw4zNyDX1puegvZLYhxI4wXR7ikA=; b=ESP1zY851/3BWfq1+TyKrkcF6XPFBT3/+VXe6ukVd2mDOW00KxwE5NXg/GMXn5CDlI nSJF7qqsWq4oahdTWEDp11HhgB+40dAH3613cLQlgpqP9BWaCh75mhbYjeDZp9TT/ZjW UiXHnRCieDcw84dggh3S38HTolTZSzeoafGQBMCXSvJkH+BcQ4R6u6XRl2zYlUCDOnkN Eil9eYucnB+sIMXE9JjySnnMc37HTBaPdyFYHvhd9FZ/58gDFqz2HNHH/WtKEMDeVEjU d3AIrF4khJzignztQXugNFzxX2PDEhkK0rdT/q2WSoPR9jD9G6FEyR1vooXQjzSLhi+9 lrKA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="mIC1QYV/"; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id 139-20020a370b91000000b006ea960d8852si807096qkl.303.2023.01.26.03.32.29 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 26 Jan 2023 03:32:29 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="mIC1QYV/"; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pL0UD-00052l-FT; Thu, 26 Jan 2023 06:32:09 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pL0U8-0004bt-C8 for qemu-devel@nongnu.org; Thu, 26 Jan 2023 06:32:04 -0500 Received: from mail-wm1-x32f.google.com ([2a00:1450:4864:20::32f]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pL0U4-0007nn-4U for qemu-devel@nongnu.org; Thu, 26 Jan 2023 06:32:03 -0500 Received: by mail-wm1-x32f.google.com with SMTP id e19-20020a05600c439300b003db1cac0c1fso3048301wmn.5 for ; Thu, 26 Jan 2023 03:31:59 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=y/TiS+4tqDBwIwjrw4zNyDX1puegvZLYhxI4wXR7ikA=; b=mIC1QYV/4deeDlFHTKHGkTHjkRS+15YrKTdotMr/AsOMqZF6nZcCzevrHO9TvMKe9q pRkhyvH8gK4BkJI66rSVUDS6EcZ8+j4hdMR1313m4U4f9NCSTp+sykF87hLbR/n0M3ZM xRUAqKBxZ0gjGGKJD0/2F/Q4tIRM1ddgdBMRQd7vmRkF3frOpQwwdiK6POAXEKgDUUoP jIHlXDClNXC2MGts6ZmvbyQlPzarOaaNr54Pykaz5nNafjGzB6hvJUuZM1GWde8+ebDM EKSPXVTTNTlJQQwpGkns8Jb733WRJNIMs0X2S+wn4nojGt0kkhZcU71fdDzr7r3Tl+VV dlRA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=y/TiS+4tqDBwIwjrw4zNyDX1puegvZLYhxI4wXR7ikA=; b=tVJH+WtjrWRRSXnH82gl/kSAzvmddrFgE2jdTNHb7wMqqRSlYRE7nIcUvmYJZ78QGc MK9YTEkfe+yUWfY2G6/+V+0OjfUt14CmUAPmjErSZ/xlBwP07YqciXETRvmebWOV14nF nuH7Z+FgRxnMd/IeAqawqXEbmfBwhKAf5iN3x/Q1ALZQjRqwjQxzaqmyZrdkQs5teUPw hPbhQpbZZRjz3oMijZnQxmrARBZLyk0bpw1xukjTLU7DkaW1tF4s3uc/K08iyG4iyDVS RvYPlm+R17hdoFS3PHCaoympe5MKviWxqvErfDpbnM9HWK0wn+ojFgloJ8A8fRVoxzFA um+A== X-Gm-Message-State: AFqh2kre8IpRt606uNFm7uKzt6uQf91zSTbkGEsJCfBizjjO8e3AQQE6 83PWbTPDXZw4cfThCk/HcOFYc0dMvXdF2kAA X-Received: by 2002:a1c:f617:0:b0:3d2:191d:2420 with SMTP id w23-20020a1cf617000000b003d2191d2420mr33473508wmc.7.1674732718479; Thu, 26 Jan 2023 03:31:58 -0800 (PST) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id o7-20020a05600c2e0700b003dafa04ecc4sm1188580wmf.6.2023.01.26.03.31.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 26 Jan 2023 03:31:56 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 6F5341FFB8; Thu, 26 Jan 2023 11:22:56 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: peter.maydell@linaro.org, =?utf-8?q?Alex_Benn=C3=A9e?= , Richard Henderson , =?utf-8?q?Philippe_Mathie?= =?utf-8?q?u-Daud=C3=A9?= Subject: [PULL 19/35] docs: add hotlinks to about preface text Date: Thu, 26 Jan 2023 11:22:34 +0000 Message-Id: <20230126112250.2584701-20-alex.bennee@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230126112250.2584701-1-alex.bennee@linaro.org> References: <20230126112250.2584701-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::32f; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x32f.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org Make it easier to navigate the documentation. Reviewed-by: Peter Maydell Acked-by: Richard Henderson Signed-off-by: Alex Bennée Reviewed-by: Philippe Mathieu-Daudé Message-Id: <20230124180127.1881110-20-alex.bennee@linaro.org> diff --git a/docs/about/index.rst b/docs/about/index.rst index 5bea653c07..bae1309cc6 100644 --- a/docs/about/index.rst +++ b/docs/about/index.rst @@ -5,19 +5,19 @@ About QEMU QEMU is a generic and open source machine emulator and virtualizer. QEMU can be used in several different ways. The most common is for -"system emulation", where it provides a virtual model of an +:ref:`System Emulation`, where it provides a virtual model of an entire machine (CPU, memory and emulated devices) to run a guest OS. -In this mode the CPU may be fully emulated, or it may work with -a hypervisor such as KVM, Xen, Hax or Hypervisor.Framework to -allow the guest to run directly on the host CPU. +In this mode the CPU may be fully emulated, or it may work with a +hypervisor such as KVM, Xen, Hax or Hypervisor.Framework to allow the +guest to run directly on the host CPU. -The second supported way to use QEMU is "user mode emulation", +The second supported way to use QEMU is :ref:`User Mode Emulation`, where QEMU can launch processes compiled for one CPU on another CPU. In this mode the CPU is always emulated. -QEMU also provides a number of standalone commandline utilities, -such as the ``qemu-img`` disk image utility that allows you to create, -convert and modify disk images. +QEMU also provides a number of standalone :ref:`command line +utilities`, such as the ``qemu-img`` disk image utility that +allows you to create, convert and modify disk images. .. toctree:: :maxdepth: 2 diff --git a/docs/system/index.rst b/docs/system/index.rst index e3695649c5..282b6ffb56 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -1,3 +1,5 @@ +.. _System Emulation: + ---------------- System Emulation ---------------- diff --git a/docs/tools/index.rst b/docs/tools/index.rst index 1edd5a8054..2151adcf78 100644 --- a/docs/tools/index.rst +++ b/docs/tools/index.rst @@ -1,3 +1,5 @@ +.. _Tools: + ----- Tools ----- diff --git a/docs/user/index.rst b/docs/user/index.rst index 2c4e29f3db..782d27cda2 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -1,3 +1,5 @@ +.. _User Mode Emulation: + ------------------- User Mode Emulation -------------------