From patchwork Fri Mar 6 11:09:55 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 184276 Delivered-To: patch@linaro.org Received: by 2002:a92:1f12:0:0:0:0:0 with SMTP id i18csp7304844ile; Fri, 6 Mar 2020 03:22:41 -0800 (PST) X-Google-Smtp-Source: ADFU+vuxrHjjt/pWJgv1I64i6yB7cF/cc4zYAAQTWxmfJeRiz859xrLkXT8AZf6knVZKRs2PMCT8 X-Received: by 2002:a0c:e406:: with SMTP id o6mr2237816qvl.136.1583493761266; Fri, 06 Mar 2020 03:22:41 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1583493761; cv=none; d=google.com; s=arc-20160816; b=bKBMnlqAUJonaEGsPyhJrrMRQiECPq9Ke7ZMtcNdEnTXOHOkyPA6/c/L1IVHVOqAYL jqtJbzY1WiHhcRuYtly3gWphM5fFy8ylrYublA5owauckhAJ/bGyVI95r0Ll4kIiyQ+r LV08ki8nVooTm4/YRt1XIJog11wJNB7PSDqWJOta0jWG9TYdsnxwr/lCbhM2I0/lu9AA 1WkWrIXDVTpWmqN19J+IhVix3AAjlt+FhttGFPdg0DaPSnpK0ZNNCIISpDZtnLBcwEuu a+alzOfGpqa2u0skOIGooiNdsMpUhy+A+w47d9AeU6eHEgOkKk8LXWScIVKfiLhMHsyH D9qA== 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:to:from :dkim-signature; bh=eAz9K3AzjJyegY4XFNXzdynmBguX2kLl9F5Z2dLMquI=; b=K8XV93kHYjb3q7yyR2G9BbPbDyJXA9LmPLe12t1CvaBa4RCSDhAActdOEdJP/mdFzm DgFA1uJe4qiEKTrgdeZUMcMgc8n5qk4b7Gzc4trDFjux94KP7ZNdsG7UecW3uyZqfD2z lzgLSBsDoPZkA/MrAHxIQJv4mGSNLrcqZqbxgqPyafMNJHyRKIAOPhGl+LPqVjf2Jwl3 It/iOYOpdi1x1mJgeJM5XgfufRP526x35Wnf+cRW0AQ54h3CxXHuZ7mQvtw8+iB7Evtf 3CD4pH/wj9JH/G5VYci3yZ1R4lzRajx54TESYzfympPZUcPpa3IHaseagoYERFNq9HnL u9Kw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=w7MldQtm; 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 z16si835349qtu.200.2020.03.06.03.22.41 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 06 Mar 2020 03:22:41 -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=w7MldQtm; 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]:35108 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jAB3w-0001QJ-O3 for patch@linaro.org; Fri, 06 Mar 2020 06:22:40 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:40094) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jAAsV-0004TN-Jn for qemu-devel@nongnu.org; Fri, 06 Mar 2020 06:10:53 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jAAsT-00064f-3z for qemu-devel@nongnu.org; Fri, 06 Mar 2020 06:10:50 -0500 Received: from mail-wm1-x330.google.com ([2a00:1450:4864:20::330]:36998) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1jAAsS-00060m-Rh for qemu-devel@nongnu.org; Fri, 06 Mar 2020 06:10:49 -0500 Received: by mail-wm1-x330.google.com with SMTP id a141so1931204wme.2 for ; Fri, 06 Mar 2020 03:10:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=eAz9K3AzjJyegY4XFNXzdynmBguX2kLl9F5Z2dLMquI=; b=w7MldQtm00YzyIKn/3tlNutVmJOuonr95yE7Ek93FSkFIf58r2Tfr2v2TfTutpURib EJ5kTiZW6QzvOq4eKbo+Ywv0ax8N6kMbjAlelN/Dh5yijG21hpxWm5wzf12NjpQtJndC 8nfMLsa58ErkNoB3F80nIZaUK/S7RAkqv2cBEkYFKu+xlAAqytYK9YY/XFauiNt342x5 SPeMYFO8apBL9SQ7A50JocTf0JWG9+trf/AyE6ETY7gyZznkAmkIXIiStzFtsxY/cGkD mWtWG1uiDBTXQYSEnTBRsop2i87mKsyYMASrcOdWHsPTh821oZU8C9hNHSu2+NtMA8bm yBFQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=eAz9K3AzjJyegY4XFNXzdynmBguX2kLl9F5Z2dLMquI=; b=FZzAl+j3ZnJwraOP/kUweZzU/fWr9iDlvfKiT+YOonz9TQemOVnXbJ7hsCD2PUXntX Tu6LbknnUPvdIGDRYdNlSkJjZCKJXhbDktnQAn9S3hKJsblAhJMZ9nAqch1+o7hQfAAE d1FJSlTlKwtPCFgjoJ70sln27SGoqIwKzpRLiXauWHKemgr+uSBJIv09GaDwP7IvpMEx 03UoCa1Hi7ixVEKa0fPaVpfKTuQR7Licg9TOG47AHLxXpQtbnQrgaEA/QJU8Hz+aIfDi Z5RBkBG8j/2qE6/3419C/LOEKzmYyqr59ISwf28amEKXbLWUwz2RBxYOkVIbod9kVWvV NMGQ== X-Gm-Message-State: ANhLgQ2UqU2VNGMz+XXQJmDYZ1nQ1RjobXwJgQ/ou897hAot3whWQ0uh b4RHVoJJMABiT3Oz60nyNCwjt76kJiurSg== X-Received: by 2002:a1c:c257:: with SMTP id s84mr2302565wmf.9.1583493047465; Fri, 06 Mar 2020 03:10:47 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y10sm12553029wma.26.2020.03.06.03.10.46 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 06 Mar 2020 03:10:46 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 29/33] docs: Generate qemu.1 manpage with Sphinx Date: Fri, 6 Mar 2020 11:09:55 +0000 Message-Id: <20200306110959.29461-30-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200306110959.29461-1-peter.maydell@linaro.org> References: <20200306110959.29461-1-peter.maydell@linaro.org> 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::330 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: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" Generate the qemu.1 manpage using Sphinx; we do this with a new top-level rst source file which is just the skeleton of the manpage and which includes .rst.inc fragments where it needs to incorporate sections from the larger HTML manuals. Signed-off-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-30-peter.maydell@linaro.org --- Makefile | 10 ++++---- docs/system/conf.py | 2 ++ docs/system/qemu-manpage.rst | 45 ++++++++++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 6 deletions(-) create mode 100644 docs/system/qemu-manpage.rst -- 2.20.1 diff --git a/Makefile b/Makefile index f7d08997dbf..ef10b9a031d 100644 --- a/Makefile +++ b/Makefile @@ -344,7 +344,8 @@ MANUAL_BUILDDIR := docs endif ifdef BUILD_DOCS -DOCS=qemu-doc.html qemu-doc.txt qemu.1 +DOCS=qemu-doc.html qemu-doc.txt +DOCS+=$(MANUAL_BUILDDIR)/system/qemu.1 DOCS+=$(MANUAL_BUILDDIR)/tools/qemu-img.1 DOCS+=$(MANUAL_BUILDDIR)/tools/qemu-nbd.8 DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-ga.8 @@ -856,7 +857,7 @@ install-doc: $(DOCS) install-sphinxdocs $(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)" ifdef CONFIG_POSIX $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1" - $(INSTALL_DATA) qemu.1 "$(DESTDIR)$(mandir)/man1" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu.1 "$(DESTDIR)$(mandir)/man1" $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man7" $(INSTALL_DATA) docs/interop/qemu-qmp-ref.7 "$(DESTDIR)$(mandir)/man7" $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 "$(DESTDIR)$(mandir)/man7" @@ -1082,7 +1083,7 @@ $(MANUAL_BUILDDIR)/user/index.html: $(call manual-deps,user) $(call define-manpage-rule,interop,qemu-ga.8) -$(call define-manpage-rule,system,qemu-block-drivers.7 qemu-cpu-models.7) +$(call define-manpage-rule,system,qemu.1 qemu-block-drivers.7 qemu-cpu-models.7) $(call define-manpage-rule,tools,\ qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\ @@ -1109,9 +1110,6 @@ docs/interop/qemu-qmp-qapi.texi: qapi/qapi-doc.texi docs/interop/qemu-ga-qapi.texi: qga/qapi-generated/qga-qapi-doc.texi @cp -p $< $@ -qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi -qemu.1: docs/system/qemu-option-trace.texi - html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html sphinxdocs info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-ref.info pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf diff --git a/docs/system/conf.py b/docs/system/conf.py index 23cab3fb364..6251849fefc 100644 --- a/docs/system/conf.py +++ b/docs/system/conf.py @@ -17,6 +17,8 @@ html_theme_options['description'] = u'System Emulation User''s Guide' # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ + ('qemu-manpage', 'qemu', u'QEMU User Documentation', + ['Fabrice Bellard'], 1), ('qemu-block-drivers', 'qemu-block-drivers', u'QEMU block drivers reference', ['Fabrice Bellard and the QEMU Project developers'], 7), diff --git a/docs/system/qemu-manpage.rst b/docs/system/qemu-manpage.rst new file mode 100644 index 00000000000..e9a25d0680f --- /dev/null +++ b/docs/system/qemu-manpage.rst @@ -0,0 +1,45 @@ +:orphan: + +.. + This file is the skeleton for the qemu.1 manpage. It mostly + should simply include the .rst.inc files corresponding to the + parts of the documentation that go in the manpage as well as the + HTML manual. + +Title +===== + +Synopsis +-------- + +.. parsed-literal:: + + |qemu_system| [options] [disk_image] + +Description +----------- + +.. include:: target-i386-desc.rst.inc + +Options +------- + +disk_image is a raw hard disk image for IDE hard disk 0. Some targets do +not need a disk image. + +.. hxtool-doc:: qemu-options.hx + +.. include:: keys.rst.inc + +.. include:: mux-chardev.rst.inc + +Notes +----- + +.. include:: device-url-syntax.rst.inc + +See also +-------- + +The HTML documentation of QEMU for more precise information and Linux +user mode emulator invocation.