From patchwork Fri Jan 13 13:39:19 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: 642035 Delivered-To: patch@linaro.org Received: by 2002:a17:522:f3c4:b0:4b4:3859:abed with SMTP id in4csp350757pvb; Fri, 13 Jan 2023 10:12:08 -0800 (PST) X-Google-Smtp-Source: AMrXdXsQ/E/CPETY9IKRhj+2G6Psdoa1hoW8Tm9J1KVrlz6hoAaq4JsoxMKy2jizztjvkuSiA2g8 X-Received: by 2002:a05:6214:418e:b0:515:5e33:5059 with SMTP id ld14-20020a056214418e00b005155e335059mr113108788qvb.26.1673633528795; Fri, 13 Jan 2023 10:12:08 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1673633528; cv=none; d=google.com; s=arc-20160816; b=wO4r6aEpTpoFN6IsU3dkCG1RD2FaXHFt4wREHAkfiH1QJxpTJQM4hb1nbaRtgAmcSO DdyF/azHMRXxsEkhnaWNmZhQbdsZLJWjBXnoMLntpzmHJK//rX4ktkRILh+ktT03EaHw ughlCJMCNaVcOc9NhnK4VF/9QtdzKiLOImtwzm4ku2Rbb/SbVjQXsKMT03cJjL+sLjge /AQth2Dhky6zvbu6m9QdVifo9ULSot8o22wJoL9XaZtRj6fGJhFaSPYlHkYtJhzn+wgt 35qiB7TRYcnRKD4rV6z7UhjVVPJUBetByD7tIlebFk1v9QAH6vYNhE93CiRzcqzTojgv Acbw== 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:message-id:date:subject:cc:to:from:dkim-signature; bh=Ag3EpefCySV9M7Y3LSu+cq8fLDk2WVcuBhQ1vB2AV0Q=; b=w7A9q8sNbUc29k9sQSk6tHZ6E5g+vK8IfSRY5QqlsMH0PPGDBaQ2qoSiGYpWExZgQX O7TVWedy4cengOSbXz/KLXRTWJqjTJugAB0qPlc9IGh3s0ID6qUXZZOLBUn1EVV4YZJV wn4TAmt9uJDRWy2JuDDDJPYeNiRTzOaJrzdRZuE3eDqsXDRUsNi1OGZxNRmSyzZxNuAY NFF/IXllgaZNMbZNf0FBDtFS24M4Nwu2Q3qc7mhVOLtyURtb5jJ/dXNvtPbtQg9TEB7x JlPwuQ8jOtAhzQCJSFBcTpCZrWc83LzOOIgYLPIVk63v+0xpidpke2GuqVX6v2fco7ch DaDg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=ffMeSMxE; 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 q1-20020a056214194100b005346e124cf5si3358973qvk.20.2023.01.13.10.12.08 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 13 Jan 2023 10:12:08 -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=ffMeSMxE; 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-0007pz-Lc; 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 1pGKHJ-0007pK-SQ for qemu-devel@nongnu.org; Fri, 13 Jan 2023 08:39:29 -0500 Received: from mail-wm1-x333.google.com ([2a00:1450:4864:20::333]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pGKHH-00052p-31 for qemu-devel@nongnu.org; Fri, 13 Jan 2023 08:39:29 -0500 Received: by mail-wm1-x333.google.com with SMTP id q8so3491241wmo.5 for ; Fri, 13 Jan 2023 05:39:26 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=Ag3EpefCySV9M7Y3LSu+cq8fLDk2WVcuBhQ1vB2AV0Q=; b=ffMeSMxEU3S1W3VzMY/uKy6VO2P1gV6iwK5gbBiVt2h0z25X+g6XaK5x+BSiiWZrSJ 5xTCdX5qpDAmRJFwASEMZReYZg0LU4TNehchieXO/crSDodCHWRABQ5sTYj0fFYMoPRq e2c/LlZsq/utCq53cy/uOREw9FTETXdAGj4dfpN/6FccO0ZXFuCGIIkp8cxBnrk99Yw/ HLT7CV+OZGBzUsHa1WRRisZZiWyb9vuTosT+CoNKpg5j532n932lx5xifGbOb2EIb0TJ YqXowydTLRsPIG76VYk79NdWxdDjqN9T63RWWjMz5cV86GnDVrShMSONSXKpaccK40VH CfyA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=Ag3EpefCySV9M7Y3LSu+cq8fLDk2WVcuBhQ1vB2AV0Q=; b=03UyZh9Sl8OhbaKeMajdjYWNb6NToEc/m4moMGAr/+fV9wrMoCugmEy3lormkFhQ5z 7Ll5aTVDp8zada1bCmTU0e3wl64qyxUn77EPPkfpx1ofCjjLv+Rfpp4j/NHo4E2SyIHK EVD7pXikGTQpNZeIQen9U2ImiRFohcs+v9wBLMxYbUAVycGXMLplJd8o8iLWvSKSC79D wW3mpqfwAEPnLmXWyfdpOWK6h+QD13UBIMFb6NQjSgl9SaOnvFm/Vd5RIUAiSAtGa+R5 gyLSZf9sIlaxjfmXeLsionjxDr+UTWyzfF/Bg4TkYtO4pV3MzE8G3V6Ial1vpfPH2CFo MY4Q== X-Gm-Message-State: AFqh2kqu94kE4wgMLn8VNqqLfA/xdh1AKhrVgdu/Pk43RUg5kUEhBFpd A8U2MAJToPU9TTAjBHkij7q05A== X-Received: by 2002:a05:600c:4f02:b0:3d9:f217:6f6b with SMTP id l2-20020a05600c4f0200b003d9f2176f6bmr14094880wmq.33.1673617165272; Fri, 13 Jan 2023 05:39:25 -0800 (PST) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id bj27-20020a0560001e1b00b0023659925b2asm19584830wrb.51.2023.01.13.05.39.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 13 Jan 2023 05:39:24 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 600D31FFB7; 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 0/4] Improve the introductory documentation Date: Fri, 13 Jan 2023 13:39:19 +0000 Message-Id: <20230113133923.1642627-1-alex.bennee@linaro.org> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::333; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x333.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 I've split this off from my bigger branch for hopefully fast review turnaround. This also includes the new semihsoting documentation and takes into account feedback from Peter on IRC. Let me know what you think. Alex Bennée (4): docs: add hotlinks to about preface text docs: add a new section to outline emulation support semihosting: add semihosting section to the docs docs: add an introduction to the system docs docs/about/emulation.rst | 183 ++++++++++++++++++++++++++++ docs/about/index.rst | 17 +-- docs/devel/tcg-plugins.rst | 2 + docs/interop/qemu-qmp-ref.rst | 2 + docs/system/arm/emulation.rst | 2 + docs/system/index.rst | 4 +- docs/system/introduction.rst | 216 ++++++++++++++++++++++++++++++++++ docs/system/multi-process.rst | 2 + docs/system/quickstart.rst | 21 ---- docs/tools/index.rst | 2 + docs/user/index.rst | 2 + qemu-options.hx | 30 ++--- 12 files changed, 436 insertions(+), 47 deletions(-) create mode 100644 docs/about/emulation.rst create mode 100644 docs/system/introduction.rst delete mode 100644 docs/system/quickstart.rst Acked-by: Richard Henderson