From patchwork Tue Feb 25 16:37:58 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 1244400 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20161025 header.b=ERS8oZ0a; dkim-atps=neutral Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 48Rl6t1tPmz9sP7 for ; Wed, 26 Feb 2020 03:40:54 +1100 (AEDT) Received: from localhost ([::1]:60144 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j6dGO-0001bG-7c for incoming@patchwork.ozlabs.org; Tue, 25 Feb 2020 11:40:52 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:42783) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j6dDl-0005xq-Bh for qemu-devel@nongnu.org; Tue, 25 Feb 2020 11:38:10 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j6dDj-0004NR-Te for qemu-devel@nongnu.org; Tue, 25 Feb 2020 11:38:09 -0500 Received: from mail-wr1-x442.google.com ([2a00:1450:4864:20::442]:45537) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j6dDj-0004MV-NY for qemu-devel@nongnu.org; Tue, 25 Feb 2020 11:38:07 -0500 Received: by mail-wr1-x442.google.com with SMTP id g3so15468751wrs.12 for ; Tue, 25 Feb 2020 08:38:04 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=33klGj+MaqDBW8JE316uDTQOxPupHP/ixtndYnSVbss=; b=ERS8oZ0aoeXqGU9Lv2Peo9wy5f5RGbESSWr63i5fm14+tLYa9hGEyAVqdFCeIXZb99 INiMoSHi/ORGzXAJWUveNPrPFhnNHuVmyUI6DSAYRP/B6LBnuzxH+O+fIyE7jH5EdfSm C3ieQa7DaU/tCD+iDCV5ld/zJJGHBT3H8XKSBDYvO9GoUcjM62gLF5CTBv8OY/zTx+dN Cq6BFxHbSwIiMUVDTAZNeYlhezRzI3sM3kSxpVT9adcVOyHb6GtNH6/IRJxVfCZFmW5Y FLdXVzZ8+ebxV5zW133iHerRx5UX1YxG3gcvk4D6o/VTEDlnBu2IfGlKoD/Ow9yXDkMy JO4g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=33klGj+MaqDBW8JE316uDTQOxPupHP/ixtndYnSVbss=; b=BlmfQiw15htdS0wI/SpzhEtjgoQtkN6iSmjjEgk1xesQ0ffuQk2jggc/8mwJxuvRBh vhH6Tf/oRqzeBJ/lySUB6uwdDOHoixiK5hhLRiaxhK5ASzrZ9/CEiH53TdVWRCTimuf2 s1JU/bFBML44XjG04Rb+uJn6+OYxbGdCJDO+eNeBEjr9H6B6XPuJ9guGl/DIwcjYSKmk 2UV9vxR42YktSCkOKrruKqtulwBxUBk/fgXDvUEUq3LoQTfahjjjCRq/a20+jvBJh/WQ enk0N/CZmh5Yiq2OeZ7FldnRPAhyhxYvuJnqp8LEk/CXEFFJiRUOU9DnZMKh8sb99OKN ejdw== X-Gm-Message-State: APjAAAVUbCEbki5bC40uRFQRiu0goDquiM+VlDj7zuKV6TTWE0D3VkYV 9P5GQ7ROO6c92hwQ4MQ5q+2kGXsI X-Google-Smtp-Source: APXvYqyPtjUKriSSwaLkX+QCZ+zfGL/1mgLwTIzZt0t0TpyDWi1a2NA3ZHoiWDnLBMfneJTD3JiCOw== X-Received: by 2002:adf:f787:: with SMTP id q7mr74031045wrp.297.1582648683289; Tue, 25 Feb 2020 08:38:03 -0800 (PST) Received: from donizetti.lan ([2001:b07:6468:f312:3577:1cfe:d98a:5fb6]) by smtp.gmail.com with ESMTPSA id q6sm18171398wrf.67.2020.02.25.08.38.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Feb 2020 08:38:02 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 4/4] qemu-doc: extract common system emulator documentation from the PC section Date: Tue, 25 Feb 2020 17:37:58 +0100 Message-Id: <20200225163758.12996-5-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.1 In-Reply-To: <20200225163758.12996-1-pbonzini@redhat.com> References: <20200225163758.12996-1-pbonzini@redhat.com> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::442 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: peter.maydell@linaro.org Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" Move the section on PC peripherals together with other targets. While some x86-specific information remains in the main system emulation chapter, it can be tackled more easily a section at a time. Signed-off-by: Paolo Bonzini --- docs/system/quickstart.texi | 2 +- qemu-doc.texi | 104 +++++++++++++++++++----------------- 2 files changed, 57 insertions(+), 49 deletions(-) diff --git a/docs/system/quickstart.texi b/docs/system/quickstart.texi index 8cd5b4bc6e..ed7295de7a 100644 --- a/docs/system/quickstart.texi +++ b/docs/system/quickstart.texi @@ -2,7 +2,7 @@ @section Quick Start @cindex quick start -Download and uncompress a hard disk image with Linux installed (e.g. +Download and uncompress a PC hard disk image with Linux installed (e.g. @file{linux.img}) and type: @example diff --git a/qemu-doc.texi b/qemu-doc.texi index 169dcd9830..996ee5952b 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -36,8 +36,8 @@ @menu * Introduction:: -* QEMU PC System emulator:: -* QEMU System emulator for non PC targets:: +* QEMU System emulator:: +* QEMU System emulator targets:: * QEMU User space emulator:: * System requirements:: * Security:: @@ -128,36 +128,77 @@ accelerator is required to use more than one host CPU for emulation. @end itemize - -@node QEMU PC System emulator -@chapter QEMU PC System emulator -@cindex system emulation (PC) +@node QEMU System emulator +@chapter QEMU System emulator +@cindex system emulation @menu -* pcsys_introduction:: Introduction -* pcsys_quickstart:: Quick Start +* pcsys_quickstart:: Quick start * sec_invocation:: Invocation * pcsys_keys:: Keys in the graphical frontends * mux_keys:: Keys in the character backend multiplexer * pcsys_monitor:: QEMU Monitor -* cpu_models:: CPU models * disk_images:: Disk Images * pcsys_network:: Network emulation -* pcsys_other_devs:: Other Devices -* direct_linux_boot:: Direct Linux Boot * pcsys_usb:: USB emulation +* pcsys_ivshmem:: Inter-VM Shared Memory Device +* direct_linux_boot:: Direct Linux Boot * vnc_security:: VNC security * network_tls:: TLS setup for network services * gdb_usage:: GDB usage @end menu -@node pcsys_introduction -@section Introduction +@include docs/system/quickstart.texi +@include docs/system/invocation.texi +@include docs/system/keys.texi +@include docs/system/mux-chardev.texi +@include docs/system/monitor.texi +@include docs/system/images.texi +@include docs/system/net.texi +@include docs/system/usb.texi +@include docs/system/ivshmem.texi +@include docs/system/linuxboot.texi +@include docs/system/vnc-security.texi +@include docs/system/tls.texi +@include docs/system/gdb.texi + +@node QEMU System emulator targets +@chapter QEMU System emulator targets +@cindex system emulation (PC) + +QEMU is a generic emulator and it emulates many machines. Most of the +options are similar for all machines. Specific information about the +various targets are mentioned in the following sections. + +@menu +* x86 (PC) System emulator:: +* PowerPC System emulator:: +* Sparc32 System emulator:: +* Sparc64 System emulator:: +* MIPS System emulator:: +* ARM System emulator:: +* ColdFire System emulator:: +* Cris System emulator:: +* Microblaze System emulator:: +* SH4 System emulator:: +* Xtensa System emulator:: +@end menu + +@node QEMU PC System emulator +@section x86 (PC) System emulator +@cindex system emulation (PC) + +@menu +* pcsys_devices:: Peripherals +* cpu_models:: CPU models +@end menu + +@node pcsys_devices +@subsection Peripherals @c man begin DESCRIPTION -The QEMU PC System emulator simulates the -following peripherals: +The QEMU PC System emulator simulates the following peripherals: @itemize @minus @item @@ -223,40 +264,7 @@ CS4231A is the chip used in Windows Sound System and GUSMAX products @c man end -@include docs/system/quickstart.texi -@include docs/system/invocation.texi -@include docs/system/keys.texi -@include docs/system/mux-chardev.texi -@include docs/system/monitor.texi @include docs/system/cpu-models-x86.texi -@include docs/system/images.texi -@include docs/system/net.texi -@include docs/system/usb.texi -@include docs/system/ivshmem.texi -@include docs/system/linuxboot.texi -@include docs/system/vnc-security.texi -@include docs/system/tls.texi -@include docs/system/gdb.texi - -@node QEMU System emulator for non PC targets -@chapter QEMU System emulator for non PC targets - -QEMU is a generic emulator and it emulates many non PC -machines. Most of the options are similar to the PC emulator. The -differences are mentioned in the following sections. - -@menu -* PowerPC System emulator:: -* Sparc32 System emulator:: -* Sparc64 System emulator:: -* MIPS System emulator:: -* ARM System emulator:: -* ColdFire System emulator:: -* Cris System emulator:: -* Microblaze System emulator:: -* SH4 System emulator:: -* Xtensa System emulator:: -@end menu @node PowerPC System emulator @section PowerPC System emulator