From patchwork Mon Mar 8 13:50:47 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: 395419 Delivered-To: patch@linaro.org Received: by 2002:a17:906:a383:0:0:0:0 with SMTP id k3csp1833293ejz; Mon, 8 Mar 2021 05:51:59 -0800 (PST) X-Google-Smtp-Source: ABdhPJxWunwA9yXC8CQGVP6wA4G804Y88hcUl63Iu8xilc3vMKKmxKwOqkMkZZvpeRnL6yR3vPCR X-Received: by 2002:a02:6014:: with SMTP id i20mr22979300jac.101.1615211519512; Mon, 08 Mar 2021 05:51:59 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1615211519; cv=none; d=google.com; s=arc-20160816; b=j9HXklT3cx2aRB4tLjt+neFwsXM0jkk7UlOQHeK+P3LbmSFPQDqU+ZXwQMFr4v/Gi8 0Fp3SCuuqXuARNHOeahJJvppOJ9JMsruFyM4IbjVIDgqQx+uBll+5VPRdh6No+K6sGOk cZUiqrWEWd4dRk0mAqA84HiI/87Dy5Odi+SRsWmKVdzoWfwWxA1jeQ0xacj+6rkEBlaK cu8SHUP5+1zT/niKxrj7vYHNnlYSCjX6+Z4iMN8vcFoDKLPIFSpnCsOV6vM15tg08w3T gZgCSWs6WhJoJoLaKvCj/o4SF6qlLP8OUs5aRvHMoosn6zRxtq2pG3LSjVxL6anmPglT 80Hg== 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=5ig15pshghu+eCUM7ti/ab+kHioEFzPWJ0umuCSDYnY=; b=CKOqvTM6wQusWEDY310R1OqeKpzyCb0HMi48FWNPC6Geu15FuehBXP6n7GP6XBwHFb kK6osAxIaRqJHI9zMMmIB2YiS9Cqe+e0Ibl1Ijm3DgEg4KKTslysQVArvVlYcTyyQwBO L/d4PPRLGxTUwC8tzqmL5TPyQN0jA8Y5HAJcNU7NJuBaRnDHsnEsvTWBIq/4Jw4D697k RHPvo9DmkTHglI2dG2k98iDpFlQLEV0J5D5jXZKBFTBipZQinwNvPtILpS0OFgyYBC3J AsV6+sRqhR16yJAxqW3wBiERU1huESQ3xWBbhfZxqsZHq6R0Tmt0fbpiEO2y8jP/lKh6 lyhA== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b="z5G/ThX5"; 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 d71si9757569jai.44.2021.03.08.05.51.59 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Mon, 08 Mar 2021 05:51:59 -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="z5G/ThX5"; 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]:37530 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lJGIg-0006M2-Om for patch@linaro.org; Mon, 08 Mar 2021 08:51:58 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:53376) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lJGHw-0006KT-70 for qemu-devel@nongnu.org; Mon, 08 Mar 2021 08:51:12 -0500 Received: from mail-wm1-x329.google.com ([2a00:1450:4864:20::329]:39426) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lJGHu-00018Z-AJ for qemu-devel@nongnu.org; Mon, 08 Mar 2021 08:51:11 -0500 Received: by mail-wm1-x329.google.com with SMTP id 124-20020a1c00820000b029010b871409cfso3836567wma.4 for ; Mon, 08 Mar 2021 05:51:08 -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=5ig15pshghu+eCUM7ti/ab+kHioEFzPWJ0umuCSDYnY=; b=z5G/ThX5vPlSTYpr7+kb7A9dA6jKSNWXefTep1CiZP5IZ35DvMyUWjd0WiPrDCpZxX pSqDjdLFnPVzlIQSzzb/DjfdA/dI87aQ7fDGeZTkeZvbwysAvDMkYIgWjuTqqcnBi5mp 3SyhgvJkcgjj5EIuPDOubzrZ61QwYUYjkYulj8Fg8eO+k87qqpKvRwheUjaXNlQAKmXf A/U/c6OzA6wt9KiB3k0bD7LCmPH+IUO+hWdIKy+d5QRZp51cwoFc6KsqsM9KB8LJMWnR iR/587KYDN9YDW99T8qAnHhF9+EWuBWVQluXFUieqScoq3H4wx5+s+3sn62gUzWAIUQz /TTA== 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=5ig15pshghu+eCUM7ti/ab+kHioEFzPWJ0umuCSDYnY=; b=akHLmzZIqDznuRd2Zh0tVYuaUiYFCzifPiWdsxB35DrZqA/vnjkSR0t/potiHVvHvZ rsXniQrS7TUqV6DRPnowrdE9f/RgZHrlL27karywFelzNpYTE78T5BuCGJ4qdsuy6aNM n2eWTcxd0VT4Iwodyz2ofjKa6VqtU7a2peJQj3gC+MFyMI3r29pnIQlmy/P3l7+KGh4v JPJujjyM9teF3TP3RDq1uKig2zfQX/hR3e+KP5+tRwbVp9do5fa/7fgHx5zruVDyGtA2 /1VLExKC5B3Xhs0n0ODaLkWhx7i36x9gD5taAnG+LO5WLXC2jOcqQvLjbfzkmlN2cIrR rJNQ== X-Gm-Message-State: AOAM531Y+PbKS5tcfvkQWEgYBE82rO6gXnC1md5U/779djfZxaq5ehA8 PxB/xsBGgiAfVd9MKNe4bvwDNQ== X-Received: by 2002:a7b:cdf7:: with SMTP id p23mr22396937wmj.26.1615211467336; Mon, 08 Mar 2021 05:51:07 -0800 (PST) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id 75sm21051147wma.23.2021.03.08.05.51.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 08 Mar 2021 05:51:05 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id D7C961FF87; Mon, 8 Mar 2021 13:51:04 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: peter.maydell@linaro.org Subject: [PULL 01/18] docs/system: add a gentle prompt for the complexity to come Date: Mon, 8 Mar 2021 13:50:47 +0000 Message-Id: <20210308135104.24903-2-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210308135104.24903-1-alex.bennee@linaro.org> References: <20210308135104.24903-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::329; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x329.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: John Snow , Thomas Huth , =?utf-8?q?Alex_Benn=C3=A9e?= , qemu-devel@nongnu.org, Stefan Hajnoczi 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: <20210305092328.31792-3-alex.bennee@linaro.org> -- 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 75ed1087fd..9dcd95dd84 100644 --- a/docs/system/targets.rst +++ b/docs/system/targets.rst @@ -1,3 +1,5 @@ +.. _system-targets-ref: + QEMU System Emulator Targets ============================