From patchwork Fri Jan 13 13:39:20 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: 642034 Delivered-To: patch@linaro.org Received: by 2002:a17:522:f3c4:b0:4b4:3859:abed with SMTP id in4csp350579pvb; Fri, 13 Jan 2023 10:11:43 -0800 (PST) X-Google-Smtp-Source: AMrXdXsnaWR2hk71mcEqgOu5tf7FUH2Shw66GJzHwfyXZCQFMupV4dXIIW22O78xEi9YNF5WK1Gu X-Received: by 2002:a25:8608:0:b0:7bf:edd2:2eca with SMTP id y8-20020a258608000000b007bfedd22ecamr15069380ybk.19.1673633503620; Fri, 13 Jan 2023 10:11:43 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1673633503; cv=none; d=google.com; s=arc-20160816; b=Nk3+E5Jz3QrPYPKRQWzQo3/CNuiN+MNGF71YAo2BTcI2sME6/+PGG/JzXbC7T+ke2I qNNMLqpf81exo+VJxkE8MNWZrNNG7EGzGGnZEIz8rxN7QgPDmSIZ9pk6eLPzYVlkxTgH PHwsf1+Z8UGWerfQTkiX93d7kJPgN0D8lebN/+FcM2dTI2jHg5twoqOK3l0datVsh7pS V6gtnUTPV0z9sgL5X6gbjEBGR9UbfAfzB7TTQYplXJBtN6HDHy5u0vVmoNYOxi7ft+j4 EYGf2F9WLYbjSuUDHBpTWS9RWk/Iwn7DfWNDxzCT7K82032oKEVJFofRhDuzrFrXFLPv ENdQ== 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=YX3naq5ZNqjOTiMOy0rg53RIUBd9djjd4qY57KHB7I4=; b=m2tC4ToPgcwkYRVc9sabK+s8A2yPQpYZ++L/l99qVHNNw7AsICLisWtc3MT0nVNfGN /GFotgaszzoyiAvYcHxVsEGm59QsvEWIwOamfbLxgrRHaGtl6z1x03zkwgMHZT3YZ0Mg VWlKTvtpK6l8qaXV7e9js728pgdqaIl/R4JnKiAZ178PNM8nlsXaVw20npFte5VBzTVI o+Fxlzu+o4l+kbXGxMzm1weoKCSR2lQp6//fBStbAKYMr7LuWRNcyAPxBvH94w92CyWm zqucq5Bm77355L7a1wSqhnHIQQw5d3e2coTp+Feili8ZhrNecYuP6sn/zwBV1safNUFq bASw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=WjTtB4O9; 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 g12-20020a05620a40cc00b006fccb6a8379si14026398qko.635.2023.01.13.10.11.43 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 13 Jan 2023 10:11:43 -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=WjTtB4O9; 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 1pGKHL-0007q0-Pg; Fri, 13 Jan 2023 08:39:31 -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 1pGKHK-0007pU-CZ for qemu-devel@nongnu.org; Fri, 13 Jan 2023 08:39:30 -0500 Received: from mail-wm1-x32b.google.com ([2a00:1450:4864:20::32b]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pGKHI-00053H-LH for qemu-devel@nongnu.org; Fri, 13 Jan 2023 08:39:30 -0500 Received: by mail-wm1-x32b.google.com with SMTP id ay40so15301380wmb.2 for ; Fri, 13 Jan 2023 05:39:28 -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=YX3naq5ZNqjOTiMOy0rg53RIUBd9djjd4qY57KHB7I4=; b=WjTtB4O9lF85m9xCCcQb5fvIhTZH14VKjxXb6Q3SUt9Gr2AsMTaUlITFig7dsa7nV9 Yt2Gku65ibAgT34l+1YnuepjlSN4zLCZ2/PDwFyIUdF2lYdzZLqP6k4gfhBWooaRRuyZ r5/19bx7PKg0+EKAf1GFbMKHUs5jsP2bTkPZajruEnq5knoiYDlafU4UVDejfz22Q3hA ac/EkfRtfD9UrwowtKTzRG6APonn50JhCd5IbdQFHmw8gJ0EiDI23rcA9p65U7PLl76T 7xWvOiiWvm4KTiWkef43n4k7nU3HSSqtJRSxgkrOzMfyP9ukDkT442vga5+OduVf96P4 bMdw== 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=YX3naq5ZNqjOTiMOy0rg53RIUBd9djjd4qY57KHB7I4=; b=H3X3J7UeclYj7Ig7HodAdbJDjBC7IQKix+tXlcKukZgBa+EbU4Who1FrVt+y85np99 GrgYlxzz1hqZtkc6gCh50lz0Cyuxloee1sCmwc9pdlw2l6bggnspnMiJMH2HCh0MRjyC etmY+nNZUw1bmDXgiOi6bsjc/020t/JgUthx6vbJPrqusr1D5ycBEUgygsC2MZtJGyax 8IjSNJhrsS//rSluCzcVeRJfUdBv0/xzQ0AgCnAuCx87DRR936eS8TdnZ99SCuEwRQ9d lkej0PyJ//aQlVbBXxZO+eln1nwJfTQydtkVJQvXFV+sdSUS/wnKq7KKXEuK/no7xLZ2 f22w== X-Gm-Message-State: AFqh2kpUKAsp9xLk7lO1PHI+q0h5Nb+6Bx8Px2q6hA8XBdG6J8fPvWhs 5fRETMO2r9CAL6yi47NNHEIbTQ== X-Received: by 2002:a05:600c:a0f:b0:3cf:7704:50ce with SMTP id z15-20020a05600c0a0f00b003cf770450cemr59571404wmp.38.1673617167180; Fri, 13 Jan 2023 05:39:27 -0800 (PST) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id bi6-20020a05600c3d8600b003d9df9e59c4sm22299090wmb.37.2023.01.13.05.39.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 13 Jan 2023 05:39:25 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 7DB921FFB8; Fri, 13 Jan 2023 13:39:23 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Alexandre Iooss , peter.maydell@linaro.org, Markus Armbruster , Mahmoud Mandour , =?utf-8?q?Alex_Benn=C3=A9e?= , Richard Henderson , John G Johnson , Elena Ufimtseva , Paolo Bonzini , Jagannathan Raman Subject: [PATCH 1/4] docs: add hotlinks to about preface text Date: Fri, 13 Jan 2023 13:39:20 +0000 Message-Id: <20230113133923.1642627-2-alex.bennee@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230113133923.1642627-1-alex.bennee@linaro.org> References: <20230113133923.1642627-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::32b; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x32b.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. Signed-off-by: Alex Bennée Reviewed-by: Peter Maydell --- docs/about/index.rst | 16 ++++++++-------- docs/system/index.rst | 2 ++ docs/tools/index.rst | 2 ++ docs/user/index.rst | 2 ++ 4 files changed, 14 insertions(+), 8 deletions(-) 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 -------------------