From patchwork Fri Mar 5 09:23:21 2021 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: 393475 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp264437jai; Fri, 5 Mar 2021 01:26:39 -0800 (PST) X-Google-Smtp-Source: ABdhPJzdXUA7M1jLuJDuIfTkdiWlwucTovGRNAGejmbnzb5Dz/rmOniRXsHP83DuFQ4Y0R1XWZ73 X-Received: by 2002:a92:b50e:: with SMTP id f14mr7502407ile.77.1614936398998; Fri, 05 Mar 2021 01:26:38 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1614936398; cv=none; d=google.com; s=arc-20160816; b=q2ZjbJqhdcqx7VXZ7lhRa82ryz5HgbTfpGmbJM6PNY1xxXEk+Md8clgvwRPtHqgxa/ BsrawBCmYnBsKFA2BODCXfHw845O5a2av1VpE4Crvt4ab8n9b6QcUO5KCnB2rnb1f61m 2rdhXOOygjWe4CC24i5FNF/rVRN7JjpcHc8U4uq3OBktVXAaUBCt57nhAmdLxpMPyKTn cBvrFubPkIsk6/oDZYslKpWQ1Hq01NTPV4uPlJAOJg6Ww6ZJTG5Q3mJ/BN3y5780jDfW kK6pnsB5V81MC3zBvDjQ8smf+77D2bAePqAepRc8rEo5bu7KraXLvbsnLFkkdBi5n5ym kQaw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc: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:to:from :dkim-signature; bh=SI1BWVRHAX1ErzEiSC9pkD2SXvG3GEi5CNrymtvJHJ8=; b=NYV+J4W8L8pUxu6y2HOofcSXc8iejVWG1FaUGRZaaBjVyTMk8jvvcxnHVHJNyXu1yl AVqkjah/Zc9dxPC3xa/n3gpv6DaaTmDgYaWGQGt39P7U/Yyjkgn60XW1dEbCH7qkbmzh p8sZAC9JYb4+yRrm8TKiA2q9GuXjkQkM5UQwmf6Jo4Ih2TacRJr0zoadXoYv/XyldB0R nRGedjV4Ohj++gO2IzywPfQ0EldAm0qNTljHMtTcB3yh/NWUY0m2DQAtmvWbMa/wQk+a ckO3SndvYCDMKVCEPv1oboHD3P3AJSabuQLnJp4G9hdAmE880Elc46rK1X8rD1Ipf60v G75A== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=mf6XOrUG; 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=fail (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 x10si1879645ion.14.2021.03.05.01.26.38 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 05 Mar 2021 01:26:38 -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=fail header.i=@linaro.org header.s=google header.b=mf6XOrUG; 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=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:36482 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lI6jG-0003sz-Df for patch@linaro.org; Fri, 05 Mar 2021 04:26:38 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33684) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lI6gM-00013v-Q9 for qemu-devel@nongnu.org; Fri, 05 Mar 2021 04:23:38 -0500 Received: from mail-wm1-x333.google.com ([2a00:1450:4864:20::333]:38964) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lI6gI-0004IS-OE for qemu-devel@nongnu.org; Fri, 05 Mar 2021 04:23:38 -0500 Received: by mail-wm1-x333.google.com with SMTP id u125so798935wmg.4 for ; Fri, 05 Mar 2021 01:23:34 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=SI1BWVRHAX1ErzEiSC9pkD2SXvG3GEi5CNrymtvJHJ8=; b=mf6XOrUGS70exrv9Iu2BUc6AO0TYS7JQWfEEhEnudOhOQWz0t530NlVcce0SAnd2Il eBAfwSx8cVLkabE5LuqPqHSRO83tQtWXlHtam1Ihgvv3iIW7BNUiCLGGN1hcKdxeyd7W pwfT5Az2/dvqtyyyuX7cV0fA5H/ARKl/r8sxIOrzGv43wZJ3YeqwBbbs7CRnhKGy1jCw 8K6wosyClvO2TKeeNSO8yCYSTNx2szbhyxOqQKbeNwSHT9NvK85Aag8GIR+WN27vVYSe xw5cVUER9bfYJVB7Pr+GvzCuvjgNgISa5vCv/ltBZul7TmtLJppKdZWEeoWkyEQB9TOo ElnQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=SI1BWVRHAX1ErzEiSC9pkD2SXvG3GEi5CNrymtvJHJ8=; b=blmPo6WF1DYzXjW6F2ZJPRvyYcufBi5faLxLTKbLtjpQJmxuiVqLkpPPCYqY20GxNa lk3TD42PyNEdmfbUOXE+LPMSVDQRiKRNgIi2TetSOVSBAG8w+r3T7a5W+9qwsiv3WIb5 dYF8vGSOwK9sZ5BWgOTh1zMIYQMdqAKw28LfA7srxEt1JP2R3O6XoSV4YwfYsVTMyV7T JtsNDh0te8TCdInoWMZGBK5mGQxdwv5tuA7umCK18kXm3qZQuSx6n17eK56FKsCuaUUL APWq/6KGjmIrFXJx+aSVXOCHNei+cihRjs7QEy3PTq51GGtdbFaaPRJHTLEoK69urALn 9I9g== X-Gm-Message-State: AOAM533WraU0o3TYrScBuL17uCRGE2e+Jy/rZvBCZofaVUTBk8TTt6ld xm7G4TKE26+FxllmCTGGpC9Ffg== X-Received: by 2002:a7b:cb81:: with SMTP id m1mr7929445wmi.117.1614936213212; Fri, 05 Mar 2021 01:23:33 -0800 (PST) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id r7sm3671116wre.25.2021.03.05.01.23.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 05 Mar 2021 01:23:29 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 209BD1FF8C; Fri, 5 Mar 2021 09:23:29 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Subject: [PATCH v1 2/9] docs/system: add a gentle prompt for the complexity to come Date: Fri, 5 Mar 2021 09:23:21 +0000 Message-Id: <20210305092328.31792-3-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210305092328.31792-1-alex.bennee@linaro.org> References: <20210305092328.31792-1-alex.bennee@linaro.org> 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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: fam@euphon.net, Thomas Huth , berrange@redhat.com, John Snow , f4bug@amsat.org, stefanha@redhat.com, crosa@redhat.com, pbonzini@redhat.com, =?utf-8?q?Alex_Benn=C3=A9e?= , aurelien@aurel32.net Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" We all know the QEMU command line can become a fiendishly complex beast. Lets gently prepare our user for the horrors to come by referencing where other example command lines can be found in the manual. Signed-off-by: Alex Bennée Reviewed-by: Stefan Hajnoczi Reviewed-by: John Snow Reviewed-by: Thomas Huth Message-Id: <20210301112741.31047-1-alex.bennee@linaro.org> --- v2 - minor grammar tweaks suggested by Thomas and John --- docs/system/quickstart.rst | 8 ++++++++ docs/system/targets.rst | 2 ++ 2 files changed, 10 insertions(+) -- 2.20.1 diff --git a/docs/system/quickstart.rst b/docs/system/quickstart.rst index 3a3acab5e7..681678c86e 100644 --- a/docs/system/quickstart.rst +++ b/docs/system/quickstart.rst @@ -11,3 +11,11 @@ Download and uncompress a PC hard disk image with Linux installed (e.g. |qemu_system| linux.img Linux should boot and give you a prompt. + +Users should be aware the above example elides a lot of the complexity +of setting up a VM with x86_64 specific defaults and assumes the +first non switch argument is a PC compatible disk image with a boot +sector. For a non-x86 system where we emulate a broad range of machine +types, the command lines are generally more explicit in defining the +machine and boot behaviour. You will find more example command lines +in the :ref:`system-targets-ref` section of the manual. diff --git a/docs/system/targets.rst b/docs/system/targets.rst index 560783644d..145cc64551 100644 --- a/docs/system/targets.rst +++ b/docs/system/targets.rst @@ -1,3 +1,5 @@ +.. _system-targets-ref: + QEMU System Emulator Targets ============================