From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551974324903881.1412938818372; Thu, 7 Mar 2019 07:58:44 -0800 (PST) Received: from localhost ([127.0.0.1]:54375 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1vPs-00068o-GM for importer@patchew.org; Thu, 07 Mar 2019 10:58:40 -0500 Received: from eggs.gnu.org ([209.51.188.92]:33846) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utD-0002VX-PP for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:24:56 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utD-0004kp-0P for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:24:55 -0500 Received: from mail-wm1-x32b.google.com ([2a00:1450:4864:20::32b]:38222) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utC-0004k4-Pa for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:24:54 -0500 Received: by mail-wm1-x32b.google.com with SMTP id a188so9577504wmf.3 for ; Thu, 07 Mar 2019 07:24:54 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.24.52 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:24:52 -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=ffmiIkxAODnkDzxVOsUwtIFuG/dowa/v+EypGasnfkk=; b=j5f+bbkJBO6tEfZymF1c0lHu5qECNwxZoGwn6I9Vw6MZgWJ5yOgSJsBvNwgCEW6HoR ejAuW0Yx5KUb3A4uitdJE7N9rpLz3dYhtj1g6U/aJRLglUE8D9CClarWP5JDvnJK+il+ x4gcsxbhK7ovg+16UkibBiRedja6eVClgC5LWUZc6ULNbFsDW6DSlgHwIEipXGK85OGV 7+EvnhghPnt4hmJbET1p/l7xqAMmKBYMKHur2+ZQ7kB1o7EozhmvvrVGxFSdaOvEPATf 1hgvmuadBTZN78qphevnJzK8bF4DDczUcUAVhHI+lrMqv+1zi69CoLI43pou+huMteTR /B2g== 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=ffmiIkxAODnkDzxVOsUwtIFuG/dowa/v+EypGasnfkk=; b=Sos31KRzwevpaIFN7LIv9o96ZY7iNYEVHHnPn1UfrxC1xiVoOpdPeS0KlWD+3va1Ca E8mfPjehx/dN4QxIKgN5HEsz0DbgswxtsaVmnc+HpHgZfoYWBoB3843NyakWk2YmindX B7u08895ezKmJWcnXgjQisqqRb2RSloVgIezEq60I3zoXtsCAE1qsH09rNw/fGODbzD5 nOLDFfbi3hn3B2pol/a/05xpWycM9zx/+aNiVv1NzI0hDGY5yQYB04mjmu3kovo84zw9 BlMwlry5LTTcd+nFb4v5pfUniiDK7m84JH94ptDqbl0zDIDicFFM5EYyTtfS/lPXZDCk Rsmg== X-Gm-Message-State: APjAAAVEkGVqTjUUN0XAg/U8m6xsif7cAByetd7k3viDNBDDsolRfO9c QomQtpHrcNYPzCugOmBRLymYkar+SfQ= X-Google-Smtp-Source: APXvYqzizdatNDlp5wva8TtZL895z6b0XEFNo2tLDVemOTLQGBGFC9IpYe9h2n/GnjZWVGbaFcYf5w== X-Received: by 2002:a1c:20d3:: with SMTP id g202mr6343180wmg.74.1551972293407; Thu, 07 Mar 2019 07:24:53 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:39 +0000 Message-Id: <20190307152450.20340-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::32b Subject: [Qemu-devel] [PULL 01/12] docs/cpu-hotplug.rst: Fix rST markup issues X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) sphinx-build complains: docs/cpu-hotplug.rst:67: ERROR: Unexpected indentation. docs/cpu-hotplug.rst:69: ERROR: Unexpected indentation. docs/cpu-hotplug.rst:74: WARNING: Block quote ends without a blank line; un= expected unindent. docs/cpu-hotplug.rst:75: WARNING: Block quote ends without a blank line; un= expected unindent. docs/cpu-hotplug.rst:76: SEVERE: Unexpected section title. } { docs/cpu-hotplug.rst:78: WARNING: Block quote ends without a blank line; un= expected unindent. These are the result of not indicating one of the literal blocks by finishing the preceding paragraph with the "::" marker. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Reviewed-by: Philippe Mathieu-Daud=C3=A9 Tested-by: Philippe Mathieu-Daud=C3=A9 Acked-by: Aleksandar Markovic Reviewed-by: Richard Henderson Reviewed-by: Cleber Rosa Message-id: 20190305172139.32662-2-peter.maydell@linaro.org Message-id: 20190228145624.24885-2-peter.maydell@linaro.org --- docs/cpu-hotplug.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cpu-hotplug.rst b/docs/cpu-hotplug.rst index cfeb79f5711..d0b06403f19 100644 --- a/docs/cpu-hotplug.rst +++ b/docs/cpu-hotplug.rst @@ -60,7 +60,7 @@ vCPU hotplug hot-plugged (no "qom-path" member). From its output in step (3), we can see that ``IvyBridge-IBRS-x86_64-cpu`` is present in socket 0, while hot-plugging a CPU into socket 1 requires passing the listed - properties to QMP ``device_add``: + properties to QMP ``device_add``:: =20 (QEMU) device_add id=3Dcpu-2 driver=3DIvyBridge-IBRS-x86_64-cpu sock= et-id=3D1 core-id=3D0 thread-id=3D0 { --=20 2.20.1 From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (209.51.188.17 [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551972825698223.718278723347; Thu, 7 Mar 2019 07:33:45 -0800 (PST) Received: from localhost ([127.0.0.1]:53900 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1v1b-0001H1-Ie for importer@patchew.org; Thu, 07 Mar 2019 10:33:35 -0500 Received: from eggs.gnu.org ([209.51.188.92]:33891) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utF-0002XJ-Vm for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:24:59 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utE-0004mB-HT for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:24:57 -0500 Received: from mail-wm1-x343.google.com ([2a00:1450:4864:20::343]:38501) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utE-0004lL-7a for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:24:56 -0500 Received: by mail-wm1-x343.google.com with SMTP id a188so9577618wmf.3 for ; Thu, 07 Mar 2019 07:24:56 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.24.53 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:24:53 -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=ouZcEyHHWbCH9g8wiJ8EsWwJ4cRIXkH+whqTdb4h1Xw=; b=GXiEpH9k2OjWIJQE3RNxVjzDV2nnHx2B9zY2uhyXnfs46TKXIdPKo0Q/WR2+hhXAdc 6D3lu24DtQLC/vYJuWcw/S1Lqy/Qv5FkiPcEiybDlILgNNLsAKcXHXWVeqbkGNr8fb6Y cmhefK3LdHnEigeH0mmNu/L2ynztExu5hBcvmtan8ksuGWS9VSpxyIDu0kx5kFrYG8VH 6DOIFzfOLEXgbrpjGRrHK/bGrrrexjTMOOc2rNZmNjzz3VGWSBwGSHR7Ugc/1mWTir2c DhV9wU9n7Pa03D58yEiaU98BV1csZPuqmVtyHX7FqmrjP6F7CgdoZlSjaxd9F0f+sTdu bopw== 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=ouZcEyHHWbCH9g8wiJ8EsWwJ4cRIXkH+whqTdb4h1Xw=; b=dky6njDKwDVIfhQuJhMrf/1uqcKeYzlZOjk3uMB3CiXchTCdQdg71NaNWW3tE6PXCe jDsEMEmXDXAincWWsfJpAGKLBLic3xoRTj5C+4jZEQsUQ91N7WxFcL/85a1Q+SRHDnob jR/bhky4VVcyLRVap7L+RqA4wx9UR2JWzVjBpVY4wwz/7rZTTbe/0XenhtS4V9vGJ2Kr wBdDlgzWkWM5p8pbMPcpUux66cgFeAaCcX7xuIKua4ftlmKmg01GC+I+wzHcgPYRF7P+ 51MT8nGnLX/fyQUPMvI0rtH+NNKYjEuBmlDL6iscOMhjuHt/NQKTH/t4AYwAvEumj5+X Swrg== X-Gm-Message-State: APjAAAVpbr5YBFyGmRWPuLIvnu+spgatQmQQZG9GQ8IZcuzuu+XvNbme pfSMyFx7yambDy4qHhJ47w4nakA+fZo= X-Google-Smtp-Source: APXvYqzl/yu2VSZ1Ij6aAfgcqYepdUL98ZalKvVeD+xypBslhp4OwFeordBMVb0Hj+POJUsGQq3+Qw== X-Received: by 2002:a05:600c:2210:: with SMTP id z16mr5992797wml.57.1551972294663; Thu, 07 Mar 2019 07:24:54 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:40 +0000 Message-Id: <20190307152450.20340-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::343 Subject: [Qemu-devel] [PULL 02/12] docs: Convert memory.txt to rst format X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Convert the memory API documentation from plain text to restructured text format. This is a very minimal conversion: all I had to change was to mark up the ASCII art parts as Sphinx expects for 'literal blocks', and fix up the bulleted lists (Sphinx expects no leading space before the bullet, and wants a blank line before after any list). Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Acked-by: Aleksandar Markovic Reviewed-by: Richard Henderson Reviewed-by: Cleber Rosa Message-id: 20190305172139.32662-3-peter.maydell@linaro.org Message-id: 20190228145624.24885-3-peter.maydell@linaro.org --- docs/devel/{memory.txt =3D> memory.rst} | 128 ++++++++++++++------------ 1 file changed, 70 insertions(+), 58 deletions(-) rename docs/devel/{memory.txt =3D> memory.rst} (85%) diff --git a/docs/devel/memory.txt b/docs/devel/memory.rst similarity index 85% rename from docs/devel/memory.txt rename to docs/devel/memory.rst index 42577e1d860..b6a4c37ea5e 100644 --- a/docs/devel/memory.txt +++ b/docs/devel/memory.rst @@ -1,19 +1,20 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D The memory API =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 The memory API models the memory and I/O buses and controllers of a QEMU machine. It attempts to allow modelling of: =20 - - ordinary RAM - - memory-mapped I/O (MMIO) - - memory controllers that can dynamically reroute physical memory regions - to different destinations +- ordinary RAM +- memory-mapped I/O (MMIO) +- memory controllers that can dynamically reroute physical memory regions + to different destinations =20 The memory model provides support for =20 - - tracking RAM changes by the guest - - setting up coalesced memory for kvm - - setting up ioeventfd regions for kvm +- tracking RAM changes by the guest +- setting up coalesced memory for kvm +- setting up ioeventfd regions for kvm =20 Memory is modelled as an acyclic graph of MemoryRegion objects. Sinks (leaves) are RAM and MMIO regions, while other nodes represent @@ -98,25 +99,30 @@ ROM device memory region types), this host memory needs= to be copied to the destination on migration. These APIs which allocate the host memory for you will also register the memory so it is migrated: - - memory_region_init_ram() - - memory_region_init_rom() - - memory_region_init_rom_device() + +- memory_region_init_ram() +- memory_region_init_rom() +- memory_region_init_rom_device() =20 For most devices and boards this is the correct thing. If you have a special case where you need to manage the migration of the backing memory yourself, you can call the functions: - - memory_region_init_ram_nomigrate() - - memory_region_init_rom_nomigrate() - - memory_region_init_rom_device_nomigrate() + +- memory_region_init_ram_nomigrate() +- memory_region_init_rom_nomigrate() +- memory_region_init_rom_device_nomigrate() + which only initialize the MemoryRegion and leave handling migration to the caller. =20 The functions: - - memory_region_init_resizeable_ram() - - memory_region_init_ram_from_file() - - memory_region_init_ram_from_fd() - - memory_region_init_ram_ptr() - - memory_region_init_ram_device_ptr() + +- memory_region_init_resizeable_ram() +- memory_region_init_ram_from_file() +- memory_region_init_ram_from_fd() +- memory_region_init_ram_ptr() +- memory_region_init_ram_device_ptr() + are for special cases only, and so they do not automatically register the backing memory for migration; the caller must manage migration if necessary. @@ -218,7 +224,7 @@ For example, suppose we have a container A of size 0x80= 00 with two subregions B and C. B is a container mapped at 0x2000, size 0x4000, priority 2; C is an MMIO region mapped at 0x0, size 0x6000, priority 1. B currently has two of its own subregions: D of size 0x1000 at offset 0 and E of size 0x1000 at -offset 0x2000. As a diagram: +offset 0x2000. As a diagram:: =20 0 1000 2000 3000 4000 5000 6000 7000 8000 |------|------|------|------|------|------|------|------| @@ -228,8 +234,9 @@ offset 0x2000. As a diagram: D: [DDDDD] E: [EEEEE] =20 -The regions that will be seen within this address range then are: - [CCCCCCCCCCCC][DDDDD][CCCCC][EEEEE][CCCCC] +The regions that will be seen within this address range then are:: + + [CCCCCCCCCCCC][DDDDD][CCCCC][EEEEE][CCCCC] =20 Since B has higher priority than C, its subregions appear in the flat map even where they overlap with C. In ranges where B has not mapped anything @@ -237,8 +244,9 @@ C's region appears. =20 If B had provided its own MMIO operations (ie it was not a pure container) then these would be used for any addresses in its range not handled by -D or E, and the result would be: - [CCCCCCCCCCCC][DDDDD][BBBBB][EEEEE][BBBBB] +D or E, and the result would be:: + + [CCCCCCCCCCCC][DDDDD][BBBBB][EEEEE][BBBBB] =20 Priority values are local to a container, because the priorities of two regions are only compared when they are both children of the same containe= r. @@ -257,6 +265,7 @@ guest accesses an address: =20 - all direct subregions of the root region are matched against the address= , in descending priority order + - if the address lies outside the region offset/size, the subregion is discarded - if the subregion is a leaf (RAM or MMIO), the search terminates, retur= ning @@ -270,36 +279,39 @@ guest accesses an address: address range), then if this is a container with its own MMIO or RAM backing the search terminates, returning the container itself. Otherwi= se we continue with the next subregion in priority order + - if none of the subregions match the address then the search terminates with no match found =20 Example memory map ------------------ =20 -system_memory: container@0-2^48-1 - | - +---- lomem: alias@0-0xdfffffff ---> #ram (0-0xdfffffff) - | - +---- himem: alias@0x100000000-0x11fffffff ---> #ram (0xe0000000-0xffffff= ff) - | - +---- vga-window: alias@0xa0000-0xbffff ---> #pci (0xa0000-0xbffff) - | (prio 1) - | - +---- pci-hole: alias@0xe0000000-0xffffffff ---> #pci (0xe0000000-0xfffff= fff) +:: =20 -pci (0-2^32-1) - | - +--- vga-area: container@0xa0000-0xbffff - | | - | +--- alias@0x00000-0x7fff ---> #vram (0x010000-0x017fff) - | | - | +--- alias@0x08000-0xffff ---> #vram (0x020000-0x027fff) - | - +---- vram: ram@0xe1000000-0xe1ffffff - | - +---- vga-mmio: mmio@0xe2000000-0xe200ffff + system_memory: container@0-2^48-1 + | + +---- lomem: alias@0-0xdfffffff ---> #ram (0-0xdfffffff) + | + +---- himem: alias@0x100000000-0x11fffffff ---> #ram (0xe0000000-0xffff= ffff) + | + +---- vga-window: alias@0xa0000-0xbffff ---> #pci (0xa0000-0xbffff) + | (prio 1) + | + +---- pci-hole: alias@0xe0000000-0xffffffff ---> #pci (0xe0000000-0xfff= fffff) =20 -ram: ram@0x00000000-0xffffffff + pci (0-2^32-1) + | + +--- vga-area: container@0xa0000-0xbffff + | | + | +--- alias@0x00000-0x7fff ---> #vram (0x010000-0x017fff) + | | + | +--- alias@0x08000-0xffff ---> #vram (0x020000-0x027fff) + | + +---- vram: ram@0xe1000000-0xe1ffffff + | + +---- vga-mmio: mmio@0xe2000000-0xe200ffff + + ram: ram@0x00000000-0xffffffff =20 This is a (simplified) PC memory map. The 4GB RAM block is mapped into the system address space via two aliases: "lomem" is a 1:1 mapping of the first @@ -336,16 +348,16 @@ rather than completing successfully; those devices ca= n use the In addition various constraints can be supplied to control how these callbacks are called: =20 - - .valid.min_access_size, .valid.max_access_size define the access sizes - (in bytes) which the device accepts; accesses outside this range will - have device and bus specific behaviour (ignored, or machine check) - - .valid.unaligned specifies that the *device being modelled* supports - unaligned accesses; if false, unaligned accesses will invoke the - appropriate bus or CPU specific behaviour. - - .impl.min_access_size, .impl.max_access_size define the access sizes - (in bytes) supported by the *implementation*; other access sizes will be - emulated using the ones available. For example a 4-byte write will be - emulated using four 1-byte writes, if .impl.max_access_size =3D 1. - - .impl.unaligned specifies that the *implementation* supports unaligned - accesses; if false, unaligned accesses will be emulated by two aligned - accesses. +- .valid.min_access_size, .valid.max_access_size define the access sizes + (in bytes) which the device accepts; accesses outside this range will + have device and bus specific behaviour (ignored, or machine check) +- .valid.unaligned specifies that the *device being modelled* supports + unaligned accesses; if false, unaligned accesses will invoke the + appropriate bus or CPU specific behaviour. +- .impl.min_access_size, .impl.max_access_size define the access sizes + (in bytes) supported by the *implementation*; other access sizes will be + emulated using the ones available. For example a 4-byte write will be + emulated using four 1-byte writes, if .impl.max_access_size =3D 1. +- .impl.unaligned specifies that the *implementation* supports unaligned + accesses; if false, unaligned accesses will be emulated by two aligned + accesses. --=20 2.20.1 From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551974010314910.0370308337158; Thu, 7 Mar 2019 07:53:30 -0800 (PST) Received: from localhost ([127.0.0.1]:54280 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1vKp-0001UW-6L for importer@patchew.org; Thu, 07 Mar 2019 10:53:27 -0500 Received: from eggs.gnu.org ([209.51.188.92]:33975) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utK-0002cP-Pr for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:04 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utF-0004nF-I6 for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:02 -0500 Received: from mail-wm1-x341.google.com ([2a00:1450:4864:20::341]:56304) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utF-0004mG-Au for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:24:57 -0500 Received: by mail-wm1-x341.google.com with SMTP id q187so9729607wme.5 for ; Thu, 07 Mar 2019 07:24:57 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.24.54 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:24:55 -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=pVNuSRuso0ZCS/SWAOMrddAXjdJB3T5dh3QneL6Kf4Q=; b=KM8ZOHV42ZJ9Z/OOy2FwVCKulW6SufPDorg3Gq7ALXdPRZrGgFDC+JMFK2xG6h1z3l XSK+zAjJYIYa4mQpVs2E8mTzP4+M6trh+wajQpCRZrvju7uNo+s5z3r8YnzF8lLkKTIZ V3pcs9m3rsLyMgAvpE0gljhe4E6jftExCv5+AHxOUbzuKqT00YUxOb6cuzfC7Se2U9vu Q4hYI59WxLpGIhbWsttqMGPGJHWa0nNfT0qvP6eF3U8x5Sgp6Mk8NUkijIDqK+Nl7vkr hLXESpErDPcglQFCsGGZzUQI9+XBNERikMShgNdFGhQvORl5XwZWdlVtUpYwBmnB0T1R MOtQ== 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=pVNuSRuso0ZCS/SWAOMrddAXjdJB3T5dh3QneL6Kf4Q=; b=NTHabzEwEMUF5SF2jOpOcUNR2exAmsUuWIrpB3Oe4KaD+sBy3yCxw0LZN1bW6huIPt CHl3BYGjYc6f5CMa8N3yBzOYQ301E62Sf7V1Z14Sf4p6kQpTYOH1Um9b8Ke9fSb1Z+LC fz6DuEaDB04Oc9MlIWuwlQuvicZ8Rx6vIvZD0/p3vxy2OogBMWawfgB4YLv5z3WUMEot qXVgAYlHW1HmjSRyVcmvNAPa/kkblrY6mVTEYBFAi6QkRGzV+2UWuAP+T6zRdFc9OPnQ bomJzDtzloJkTnwqG8Z6ClL5qcf4LF6Jkw9i8+rF0sfhq7Mk+0I2uHBhvMAAhl3UQN5m eUOg== X-Gm-Message-State: APjAAAXdY35kX5lelYOwWSVIBuXqczhV12w3rUpjCpu/Bb0Ft2uO5Xtv 2FfTEnW8bIXuYOeRKONhaJGSmUfkMSM= X-Google-Smtp-Source: APXvYqx+aXPRA1o4ZxYHytsNzL6sGq8wQ+BZuGpsUGMbgSvfzscnVuPHpOyS8kBsxcy0x+9vIU15Ww== X-Received: by 2002:a7b:c348:: with SMTP id l8mr1857737wmj.135.1551972295840; Thu, 07 Mar 2019 07:24:55 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:41 +0000 Message-Id: <20190307152450.20340-4-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::341 Subject: [Qemu-devel] [PULL 03/12] docs: Commit initial files from sphinx-quickstart X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Commit the initial Sphinx conf.py and skeleton index.rst as generated with sphinx-quickstart. We'll update these to add QEMU-specific tweaks in subsequent commits. Signed-off-by: Peter Maydell Acked-by: Aleksandar Markovic Acked-by: Richard Henderson Message-id: 20190305172139.32662-4-peter.maydell@linaro.org Message-id: 20190228145624.24885-4-peter.maydell@linaro.org --- docs/conf.py | 168 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 20 ++++++ 2 files changed, 188 insertions(+) create mode 100644 docs/conf.py create mode 100644 docs/index.rst diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000000..53a17506615 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,168 @@ +# -*- coding: utf-8 -*- +# +# QEMU documentation build configuration file, created by +# sphinx-quickstart on Thu Jan 31 16:40:14 2019. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another direc= tory, +# add these directories to sys.path here. If the directory is relative to = the +# documentation root, use os.path.abspath to make it absolute, like shown = here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx =3D '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions =3D [] + +# Add any paths that contain templates here, relative to this directory. +templates_path =3D ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix =3D ['.rst', '.md'] +source_suffix =3D '.rst' + +# The master toctree document. +master_doc =3D 'index' + +# General information about the project. +project =3D u'QEMU' +copyright =3D u'2019, The QEMU Project Developers' +author =3D u'The QEMU Project Developers' + +# The version info for the project you're documenting, acts as replacement= for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version =3D u'4.0' +# The full version, including alpha/beta/rc tags. +release =3D u'4.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language =3D None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns =3D ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style =3D 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos =3D False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme =3D 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a th= eme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options =3D {} + +# Add any paths that contain custom static files (such as style sheets) he= re, +# relative to this directory. They are copied after the builtin static fil= es, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path =3D ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sideba= rs +html_sidebars =3D { + '**': [ + 'relations.html', # needs 'show_related': True theme option to di= splay + 'searchbox.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename =3D 'QEMUdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements =3D { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents =3D [ + (master_doc, 'QEMU.tex', u'QEMU Documentation', + u'The QEMU Project Developers', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages =3D [ + (master_doc, 'qemu', u'QEMU Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents =3D [ + (master_doc, 'QEMU', u'QEMU Documentation', + author, 'QEMU', 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000000..93f82228310 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. QEMU documentation master file, created by + sphinx-quickstart on Thu Jan 31 16:40:14 2019. + You can adapt this file completely to your liking, but it should at lea= st + contain the root `toctree` directive. + +Welcome to QEMU's documentation! +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` --=20 2.20.1 From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551974461676846.2619706940575; Thu, 7 Mar 2019 08:01:01 -0800 (PST) Received: from localhost ([127.0.0.1]:54453 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1vS6-0008Sr-NI for importer@patchew.org; Thu, 07 Mar 2019 11:00:58 -0500 Received: from eggs.gnu.org ([209.51.188.92]:33921) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utH-0002Z8-IT for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:00 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utG-0004oZ-Rl for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:24:59 -0500 Received: from mail-wr1-x42b.google.com ([2a00:1450:4864:20::42b]:40931) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utG-0004nq-Kv for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:24:58 -0500 Received: by mail-wr1-x42b.google.com with SMTP id y6so2753911wrn.7 for ; Thu, 07 Mar 2019 07:24:58 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.24.55 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:24:56 -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=b4wp0Zldv0QDS0gA/tU3T4n56vf8z23+TnHFMHk0phA=; b=U6fIyrx5aS3tVC3Y1iy//pbcQxb/elZu5E2eVeWpPeGXhBDbxSSpRLWfoduQCJFi/J BcIHq4/fDFUGZBzxkh5i6r7H90vTj5FdiK+RkbG+WnYXFTN6bEOAyGl+xrvk6Z37w7ZW 7LOONt8kGyOu5gC1HWT8tdR4BRKCxHSH27IrmPwMSSlYfD6M4eYOvDLOfHjwXWZ8BO71 Z8dKb2dYy+PNPBkFQIKwkKjTua85R9oDPZI66CCf9KLjQ+QiW61y0JpUclKGJYe+fFXj V2KepB1+AF7oVv+8kUPiKEwGqqOChYZA9rHk8nHqmhz6wxJxMo5d0wsPTfUOVbs+8N6K +tiA== 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=b4wp0Zldv0QDS0gA/tU3T4n56vf8z23+TnHFMHk0phA=; b=XX611Cc4cPsA76g+xLkj48dtDPLzW1aeGVqUYbG2c4v2A3QXlN2CAfSoA1JoSMGSvY gYIY6TKTjeeRW84Q5wJngn6IjmaNQpuj9ZmS+fSD/kMnSON/Cw2i7zs2b89hyf+IS2H7 Pgt5zErsJMMjfoLBIW6tY0gOgN3d+h8dVzigWwdY0C0I2MfCHTeMthjrruXXJBoiHwy9 VaEFrdQejv88u0kdazXTiQ7+xCIZfQQMZSX/j0bqjO1INwxaGyhYiHpq7OGdvXohKgvt PH4HNu51Z6QO5lXgW60eB/jVHwV68Y4s7G8UDvWOkofcI8AvfqeOyHj2EVWkJJi5dVUM BcWg== X-Gm-Message-State: APjAAAW//wfz/ERXhEpVfT+Wv2QIo5LImxd0uhyYto3NkU1EstEBin/+ KxB/R0bIAvAXWXJcUxPkNKpT5GfoIFA= X-Google-Smtp-Source: APXvYqzbNSxcLytl6swzPnrMv6jOd/tGTXVPDz78kdEWRIEB6E8VUYH6RE3aClG+1SYeFf33AX7DvQ== X-Received: by 2002:a5d:6682:: with SMTP id l2mr7057782wru.271.1551972297409; Thu, 07 Mar 2019 07:24:57 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:42 +0000 Message-Id: <20190307152450.20340-5-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42b Subject: [Qemu-devel] [PULL 04/12] docs/conf.py: Disable unused _static directory X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) We don't yet have any custom static files, so disable this config file setting to avoid a warning from sphinx about not being able to find the directory. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Acked-by: Aleksandar Markovic Reviewed-by: Richard Henderson Message-id: 20190305172139.32662-5-peter.maydell@linaro.org Message-id: 20190228145624.24885-5-peter.maydell@linaro.org --- docs/conf.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 53a17506615..e1d08a34a65 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,11 @@ html_theme =3D 'alabaster' # Add any paths that contain custom static files (such as style sheets) he= re, # relative to this directory. They are copied after the builtin static fil= es, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path =3D ['_static'] +# QEMU doesn't yet have any static files, so comment this out so we don't +# get a warning about a missing directory. +# If we do ever add this then it would probably be better to call the +# subdirectory sphinx_static, as the Linux kernel does. +# html_static_path =3D ['_static'] =20 # Custom sidebar templates, must be a dictionary that maps document names # to template names. --=20 2.20.1 From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551973843977146.59298531391403; Thu, 7 Mar 2019 07:50:43 -0800 (PST) Received: from localhost ([127.0.0.1]:54224 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1vI6-0007QN-Vu for importer@patchew.org; Thu, 07 Mar 2019 10:50:39 -0500 Received: from eggs.gnu.org ([209.51.188.92]:33941) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utI-0002aE-PM for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:01 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utH-0004pR-UM for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:00 -0500 Received: from mail-wr1-x42f.google.com ([2a00:1450:4864:20::42f]:44642) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utH-0004oe-Mo for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:24:59 -0500 Received: by mail-wr1-x42f.google.com with SMTP id w2so17889187wrt.11 for ; Thu, 07 Mar 2019 07:24:59 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.24.57 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:24:57 -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=A8sPEVb12cH+jVzl7hkemOMsmSmOId2GSXqf1Fox3x0=; b=z31+oawqCjLWu/kVkPd40GhwHFKeIXEZyA4FYFSdz6+5aNz6nZF7VmlivOizuRDn4a lXpKk5iJGMSRkRzEWrV24osJJwDDD0ppXevX0HvD1IyssZYTZ8zddF92w8cyr52iSTtH Qgc/fDNh7Ez3h4fRtF3TNGssXLJ4ruyLByN+gfZoaOoZ3b4M4Y/UcFR3mkTaleQdENUr WaFoKoEGg50+15NWRj7Q+dxA7qUtmS58SViO1dffBuwKMizHEjFP78ZGoGAMta1P7mBO XyyhWILNBi69r4clJXhFoKk0JpDCYtpSmzHVrPPslB+ztsLgzfIKrFJp4ZMRRYchIw8a J0AA== 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=A8sPEVb12cH+jVzl7hkemOMsmSmOId2GSXqf1Fox3x0=; b=sm1DTJNt4oDzItOIWOEyx6XcU3eNT0N0Sbzvtg7wBIVq+BXmj8OxFxZBRfYySa2euS /wOR0nybGFMpysG8g66QtnaEGGLV0D0wVlAKPb5+d1InZP8WDtxwmIST4AbiuM1jXVly Usypx0NIpkQnxNt9PTXR1a2I6FMA5tdYGrmaHHbnbYlw5p2mM4OhxBiZ0U6ZHGRutn3i T76X0qcwtGXXrflZZxu2mTVu+eYs4LJ/fBfGA3Zp/7SkkpUj0dQ87HI1ePzoy0XdJiua 8AEXei/4UvYR/viGbyJD7u8Yhh3A/zIoVTPq9EWHC2orHxB5L2n/zGefXKhqebmvP+EM MNNg== X-Gm-Message-State: APjAAAUoHNpc3mT06e22wA5IkjTg+/1BCf3Hj7JXRP+vt5U2EhQKBcHU jvarUwN1I/Xd3+euVdZZDYSBnUsTYgE= X-Google-Smtp-Source: APXvYqwDgOuhdg/HzmUdORQrC96/0wJmgcglG8FEdWcwBwr9r8bk4g9xeX4FDD69jBww+MiESfzM8A== X-Received: by 2002:adf:f40d:: with SMTP id g13mr7270834wro.18.1551972298413; Thu, 07 Mar 2019 07:24:58 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:43 +0000 Message-Id: <20190307152450.20340-6-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42f Subject: [Qemu-devel] [PULL 05/12] docs/conf.py: Configure the 'alabaster' theme X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Add the 'navigation' bar to the sidebar, which for some reason is not enabled by default. Remove 'relations', which is effectively disabled anyway and isn't useful for us. This requires that we mandate having at least Sphinx 1.3, where the theme was added. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Acked-by: Aleksandar Markovic Message-id: 20190305172139.32662-6-peter.maydell@linaro.org Message-id: 20190228145624.24885-6-peter.maydell@linaro.org --- docs/conf.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index e1d08a34a65..d118757cbd3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,8 @@ =20 # If your documentation needs a minimal Sphinx version, state it here. # -# needs_sphinx =3D '1.0' +# 1.3 is where the 'alabaster' theme was shipped with Sphinx. +needs_sphinx =3D '1.3' =20 # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -106,7 +107,8 @@ html_theme =3D 'alabaster' # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sideba= rs html_sidebars =3D { '**': [ - 'relations.html', # needs 'show_related': True theme option to di= splay + 'about.html', + 'navigation.html', 'searchbox.html', ] } --=20 2.20.1 From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551973001489791.6822918751809; Thu, 7 Mar 2019 07:36:41 -0800 (PST) Received: from localhost ([127.0.0.1]:53994 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1v4V-0003ui-Fh for importer@patchew.org; Thu, 07 Mar 2019 10:36:35 -0500 Received: from eggs.gnu.org ([209.51.188.92]:33952) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utJ-0002b1-FU for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:03 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utI-0004q0-Nw for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:01 -0500 Received: from mail-wm1-x32b.google.com ([2a00:1450:4864:20::32b]:40527) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utI-0004pV-Gt for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:00 -0500 Received: by mail-wm1-x32b.google.com with SMTP id g20so9559632wmh.5 for ; Thu, 07 Mar 2019 07:25:00 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.24.58 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:24:58 -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=q2B6PKoxMqgz73WQWw93UO+F5oneC53SxE8dLgiuRYs=; b=csbrY6q+SDxUzZ37e8lS0ZOrpI1tjH+Ql0EYhyRt2d6QxMv2ETBHeWslEkd2SVsWr9 kJvijgogW0xnLfJnMFfirCWO6wvmHXxhh1EZxkhWmuFB5dJw/r7Lp0+1cJ44xS0YxVIg tli4niIZ/6mnfGb5zR7A4wqk0qghXwPOcrYJqp4JCB+EHYIzHbykegXpQut9RGUIsZuc gcu+cpfKbPvZV/MC9RzcrAr+P+1THmZwIgovtE0fXNu0p3xq+se5E4MDzgO6JzxKfEA2 3JxHEaqhwQkCgclGDafhtQ3ACs8AxoV1kyQNrG3ez7h/FRibzppbD6vWBVOSKROn7b9f bROQ== 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=q2B6PKoxMqgz73WQWw93UO+F5oneC53SxE8dLgiuRYs=; b=oYjB3jwsMjDkJpU0vziZLltw0Pm+cY33GEHylV03TrE2H3dp54WTBFFn3oCyMIs72b cva0sTAnIeCTRJ87GSPjXXk9rII9BHnpQdO3/Alme+ShaXcb7jKcJyHFl9dVNNqsQU57 fAL8V2qCOvbmCixWZ8Vr+5dVmMr0nnbtbshFj70sA1wQhEeT2BbM20EaP74oR6k011ZI B4Igb5AmrBEzVJAPEgT+OA+j7yARDv98UP0Ns5ab+IlLbdpyK5c5V+CmCEhvMlvjAmy2 nKVogkXZ4AmqxUl9nn33xFlOThenup6HcSCEdCAUjQO5XBqx1J4Fn3YJvZ7a4u6536t4 J6JQ== X-Gm-Message-State: APjAAAW43fEIAKvHio0tc1A5xD9ujDCwGsCzy6hot/3UUf3E7KT9K2lB QCRMSofWlxZDgMPZXHo/4KWkTfLOpng= X-Google-Smtp-Source: APXvYqy14/8BRNf/GmEpkfmmFRpGNbbdvdFjenhPHd6141NEs1mJgFqS0PQmqcqBtwXYOehsB6JSbA== X-Received: by 2002:a1c:20d3:: with SMTP id g202mr6343469wmg.74.1551972299346; Thu, 07 Mar 2019 07:24:59 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:44 +0000 Message-Id: <20190307152450.20340-7-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::32b Subject: [Qemu-devel] [PULL 06/12] docs/conf.py: Don't include rST sources in HTML build X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Sphinx defaults to including all the rST source files in the HTML build and making each HTML page link to the source file. Disable that. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Acked-by: Aleksandar Markovic Reviewed-by: Richard Henderson Message-id: 20190305172139.32662-7-peter.maydell@linaro.org Message-id: 20190228145624.24885-7-peter.maydell@linaro.org --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index d118757cbd3..d3018bc5395 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -113,6 +113,9 @@ html_sidebars =3D { ] } =20 +# Don't copy the rST source files to the HTML output directory, +# and don't put links to the sources into the output HTML. +html_copy_source =3D False =20 # -- Options for HTMLHelp output ------------------------------------------ =20 --=20 2.20.1 From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551972521711450.75072790777676; Thu, 7 Mar 2019 07:28:41 -0800 (PST) Received: from localhost ([127.0.0.1]:53809 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1uwo-0005Ye-Ko for importer@patchew.org; Thu, 07 Mar 2019 10:28:38 -0500 Received: from eggs.gnu.org ([209.51.188.92]:33972) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utK-0002cC-Gx for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:03 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utJ-0004rF-Rg for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:02 -0500 Received: from mail-wm1-x32e.google.com ([2a00:1450:4864:20::32e]:52257) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utJ-0004qB-Jw for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:01 -0500 Received: by mail-wm1-x32e.google.com with SMTP id f65so9650826wma.2 for ; Thu, 07 Mar 2019 07:25:01 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.24.59 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:24:59 -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=bQKmeLklipx4+UDcAghdBMXAYT0DF7j3QZDmmnX7tWo=; b=nSIDVDGKp7elCq1uk8hBiLpOXPoAR6+ubPM4d33Ugd8JsTJSlxR9WcM0K9ib/lu9WA U9ieU5tXUHr7opH5EHUaO8+yS961pUIkStZBDDHzxWg9BRRsC64JmtjzI3E8G6coFSWk CbBV7dqfsNzl114qN0AOymhebn47Pq4QWlZLgIOEXdkkjws8/eFOvH7LPDu7rW/3BUh/ koLGW+cZFFdOvjHJVaKaXbazQ4Sirz4DojIW4+EAMxHhmafmNkw8Kx6dd/oKCTs34E+8 NuP+ZVUheLcnUkArP9DpIBON8Iw5sA/SqYpVpSL0/k9NqHeh8MNrdel6dte6UhYwFy+x SoRg== 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=bQKmeLklipx4+UDcAghdBMXAYT0DF7j3QZDmmnX7tWo=; b=BKIH8rYEOfu6dO+uv+cDtvWENAqFnVZwTbGZpHxf+M0KmQ9HwQhorxDB08gInKfURw VQmvuE83lVP7nC9adu1YY+5Zk3Oi32kC4xlryPWN8scPEX6gJM1rHyLuSxdqkkvzwIKv TO/Y/jJzmsBRHbDwK9flb7ilxRyQt0RK7Pj7ubNUY9QGKeYL2qLSl1stVhHx9KrH3GzV gDoqqIIn6qHUPgY3muu1XdmiP0Mm/INQkW/xfepAf6G1Zmm35gXrWCdg9X27If1lRlJO xb9yupQ+O8U7uoLQl1e7i+/25Ftbr4Wnh+dYGVGRrwgS6l4eDJbzYFA996RSnHloivZQ sFEQ== X-Gm-Message-State: APjAAAXydZ6PJ4DVtrv/qNO6HImy7efuKj8bb7kgvqNNkxwRgsjHsnXV z/GacdtFkn2Cpl11cTEupuimDqWJfJk= X-Google-Smtp-Source: APXvYqzFS9CNeFtdD4BqKXGHQqqhsl1RyHhTrhqbqAjttMEJVs+n/aOWG9BTFqqfjgND8dCWICxR4A== X-Received: by 2002:a1c:a98b:: with SMTP id s133mr5788691wme.129.1551972300231; Thu, 07 Mar 2019 07:25:00 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:45 +0000 Message-Id: <20190307152450.20340-8-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::32e Subject: [Qemu-devel] [PULL 07/12] docs/conf.py: Disable option warnings X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) sphinx-build complains about using :option: to mark up option flags that it doesn't know about (because they were not defined using the "option::" directive): docs/pr-manager.rst:68: WARNING: unknown option: -d Suppress these warnings. This way we get the semantic markup of the option flag but no cross-referencing hyperlink. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Acked-by: Aleksandar Markovic Reviewed-by: Richard Henderson Message-id: 20190305172139.32662-8-peter.maydell@linaro.org Message-id: 20190228145624.24885-8-peter.maydell@linaro.org --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index d3018bc5395..56a74e0fcb3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -77,6 +77,9 @@ pygments_style =3D 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos =3D False =20 +# Sphinx defaults to warning about use of :option: for options not defined +# with "option::" in the document being processed. Turn that off. +suppress_warnings =3D ["ref.option"] =20 # -- Options for HTML output ---------------------------------------------- =20 --=20 2.20.1 From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: temperror (zoho.com: Error in retrieving data from DNS) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=temperror (zoho.com: Error in retrieving data from DNS) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551972897963790.296575636359; Thu, 7 Mar 2019 07:34:57 -0800 (PST) Received: from localhost ([127.0.0.1]:53936 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1v2e-00025w-9K for importer@patchew.org; Thu, 07 Mar 2019 10:34:42 -0500 Received: from eggs.gnu.org ([209.51.188.92]:33997) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utM-0002g9-DY for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:10 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utL-0004sC-1N for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:04 -0500 Received: from mail-wr1-x436.google.com ([2a00:1450:4864:20::436]:34451) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utK-0004rO-OD for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:02 -0500 Received: by mail-wr1-x436.google.com with SMTP id f14so17901594wrg.1 for ; Thu, 07 Mar 2019 07:25:02 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.25.00 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:25:00 -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=IX9qKKzwk61zZjXcvq07eP/w0tNuz575ed5tl/v43lU=; b=REyGfFW508F+MNxmgzDMshzlbzl0tUq8mkqOG905rgGnupcATsVS4HDiDPLzZVAcdS rSgJtE/SWoNHsJpbnqYmyw2wQDncvhT1vSGREO+bmpTlJ9jFzDNOEzOBp5svV8LYpx7i NFjYeYAfy/RUX2sz6DiE83/xe31h9gPJDa97bUW2KXQDG+DrwBTd4s2Zwan54qZnoctz ONtuWUuiusdTzs8dLQAXRDw0JzOhx8UDZCozYi72n/MB7YPJIInbnam9NNtyK94s85+e Tr1fJUGV9vE+2ZkWxpDAFkscverel3bA0q2WxOBaTLH1+MRfa4Xf1n6f33GkAwLnhFh1 umBQ== 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=IX9qKKzwk61zZjXcvq07eP/w0tNuz575ed5tl/v43lU=; b=o+J4u7OKZsbUv+SB3S7VReFBBfd3nsb9ya9fj2K/AciJkcOIJdw3S1WM8lItLPLL7n j00E52xCVzrWNs0/pCZojUiw/ASsVCRMawMp62CkwfZPIq+yySbFxp+7u84Mb2YslcIg Xsmdoyjs66cEwExq1RsUBr5C3dZRtmCt0Vq5F4u0eYUs2LSgWpDE60y76jKsor/XpbeF NefPgsBMJFu7DIxMFTg2t4ZUoGPV/D4NYGOP7kA2RXDANgsr50AXkwpxyyEq9hX5Ei9F JYjHdq2vz941kvkipU+wopjXLJFwEPxhS6lvVPHSdtTIfTkbsDBCAYXu24bWJHCBGU25 t5Sg== X-Gm-Message-State: APjAAAW+/1dNFFj62Y22cZBwjto2OBt/0Sr8zq8xx21wKneoVDS8B4MC JZvaJhq32mRgL5xbn23E5l3N/kRk6Jg= X-Google-Smtp-Source: APXvYqxdUVJwK/Kc2iK3PsNoK1EJAz4dxkSKBQUlKSDa3yr37TIoHwbed5lOQwU0VtOJpLixcDSZrQ== X-Received: by 2002:a5d:6ace:: with SMTP id u14mr2256460wrw.240.1551972301395; Thu, 07 Mar 2019 07:25:01 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:46 +0000 Message-Id: <20190307152450.20340-9-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::436 Subject: [Qemu-devel] [PULL 08/12] docs: Provide separate conf.py for each manual we want X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) By default Sphinx wants to build a single manual at once. For QEMU, this doesn't suit us, because we want to have separate manuals for "Developer's Guide", "User Manual", and so on, and we don't want to ship the Developer's Guide to end-users. However, we don't want to completely duplicate conf.py for each manual, and we'd like to continue to support "build all docs in one run" for third-party sites like readthedocs.org. Make the top-level conf.py support two usage forms: (1) as a common config file which is included by the conf.py for each of QEMU's manuals: in this case sphinx-build is run multiple times, once per subdirectory. (2) as a top level conf file which will result in building all the manuals into a single document: in this case sphinx-build is run once, on the top-level docs directory. Provide per-manual conf.py files and top level pages for our first two manuals: * QEMU Developer's Guide (docs/devel) * QEMU System Emulation Management and Interoperability Guide (docs/interop) Reviewed-by: Alex Benn=C3=A9e Signed-off-by: Peter Maydell Acked-by: Aleksandar Markovic Message-id: 20190305172139.32662-9-peter.maydell@linaro.org Message-id: 20190228145624.24885-9-peter.maydell@linaro.org --- docs/conf.py | 37 +++++++++++++++++++++++++++++++------ docs/devel/conf.py | 15 +++++++++++++++ docs/devel/index.rst | 21 +++++++++++++++++++++ docs/index.rst | 9 ++------- docs/interop/conf.py | 15 +++++++++++++++ docs/interop/index.rst | 18 ++++++++++++++++++ 6 files changed, 102 insertions(+), 13 deletions(-) create mode 100644 docs/devel/conf.py create mode 100644 docs/devel/index.rst create mode 100644 docs/interop/conf.py create mode 100644 docs/interop/index.rst diff --git a/docs/conf.py b/docs/conf.py index 56a74e0fcb3..f452e424cfe 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,6 +3,20 @@ # QEMU documentation build configuration file, created by # sphinx-quickstart on Thu Jan 31 16:40:14 2019. # +# This config file can be used in one of two ways: +# (1) as a common config file which is included by the conf.py +# for each of QEMU's manuals: in this case sphinx-build is run multiple +# times, once per subdirectory. +# (2) as a top level conf file which will result in building all +# the manuals into a single document: in this case sphinx-build is +# run once, on the top-level docs directory. +# +# QEMU's makefiles take option (1), which allows us to install +# only the ones the user cares about (in particular we don't want +# to ship the 'devel' manual to end-users). +# Third-party sites such as readthedocs.org will take option (2). +# +# # This file is execfile()d with the current directory set to its # containing dir. # @@ -12,13 +26,22 @@ # All configuration values have a default; values that are commented out # serve to show the default. =20 +import os +import sys + +# The per-manual conf.py will set qemu_docdir for a single-manual build; +# otherwise set it here if this is an entire-manual-set build. +# This is always the absolute path of the docs/ directory in the source tr= ee. +try: + qemu_docdir +except NameError: + qemu_docdir =3D os.path.abspath(".") + # If extensions (or modules to document with autodoc) are in another direc= tory, # add these directories to sys.path here. If the directory is relative to = the -# documentation root, use os.path.abspath to make it absolute, like shown = here. +# documentation root, use an absolute path starting from qemu_docdir. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +# sys.path.insert(0, os.path.join(qemu_docdir, "my_subdir")) =20 =20 # -- General configuration ------------------------------------------------ @@ -91,8 +114,10 @@ html_theme =3D 'alabaster' # Theme options are theme-specific and customize the look and feel of a th= eme # further. For a list of options available for each theme, see the # documentation. -# -# html_theme_options =3D {} +# We initialize this to empty here, so the per-manual conf.py can just +# add individual key/value entries. +html_theme_options =3D { +} =20 # Add any paths that contain custom static files (such as style sheets) he= re, # relative to this directory. They are copied after the builtin static fil= es, diff --git a/docs/devel/conf.py b/docs/devel/conf.py new file mode 100644 index 00000000000..7441f87e7f5 --- /dev/null +++ b/docs/devel/conf.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# +# QEMU documentation build configuration file for the 'devel' manual. +# +# This includes the top level conf file and then makes any necessary tweak= s. +import sys +import os + +qemu_docdir =3D os.path.abspath("..") +parent_config =3D os.path.join(qemu_docdir, "conf.py") +exec(compile(open(parent_config, "rb").read(), parent_config, 'exec')) + +# This slightly misuses the 'description', but is the best way to get +# the manual title to appear in the sidebar. +html_theme_options['description'] =3D u'Developer''s Guide' diff --git a/docs/devel/index.rst b/docs/devel/index.rst new file mode 100644 index 00000000000..cd0fa6c9ba2 --- /dev/null +++ b/docs/devel/index.rst @@ -0,0 +1,21 @@ +.. This is the top level page for the 'devel' manual. + + +QEMU Developer's Guide +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +This manual documents various parts of the internals of QEMU. +You only need to read it if you are interested in reading or +modifying QEMU's source code. + +Contents: + +.. toctree:: + :maxdepth: 2 + + loads-stores + memory + migration + stable-process + testing + diff --git a/docs/index.rst b/docs/index.rst index 93f82228310..3690955dd1f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,11 +10,6 @@ Welcome to QEMU's documentation! :maxdepth: 2 :caption: Contents: =20 + interop/index + devel/index =20 - -Indices and tables -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/interop/conf.py b/docs/interop/conf.py new file mode 100644 index 00000000000..cf3c69d4a7e --- /dev/null +++ b/docs/interop/conf.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# +# QEMU documentation build configuration file for the 'interop' manual. +# +# This includes the top level conf file and then makes any necessary tweak= s. +import sys +import os + +qemu_docdir =3D os.path.abspath("..") +parent_config =3D os.path.join(qemu_docdir, "conf.py") +exec(compile(open(parent_config, "rb").read(), parent_config, 'exec')) + +# This slightly misuses the 'description', but is the best way to get +# the manual title to appear in the sidebar. +html_theme_options['description'] =3D u'System Emulation Management and In= teroperability Guide' diff --git a/docs/interop/index.rst b/docs/interop/index.rst new file mode 100644 index 00000000000..2df977dd529 --- /dev/null +++ b/docs/interop/index.rst @@ -0,0 +1,18 @@ +.. This is the top level page for the 'interop' manual. + + +QEMU System Emulation Management and Interoperability Guide +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +This manual contains documents and specifications that are useful +for making QEMU interoperate with other software. + +Contents: + +.. toctree:: + :maxdepth: 2 + + bitmaps + live-block-operations + pr-helper + --=20 2.20.1 From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551974141970947.2712391893498; Thu, 7 Mar 2019 07:55:41 -0800 (PST) Received: from localhost ([127.0.0.1]:54334 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1vMy-0003ah-89 for importer@patchew.org; Thu, 07 Mar 2019 10:55:40 -0500 Received: from eggs.gnu.org ([209.51.188.92]:34014) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utN-0002h5-Co for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:07 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utM-0004uV-7q for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:05 -0500 Received: from mail-wm1-x332.google.com ([2a00:1450:4864:20::332]:54944) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utL-0004sZ-S7 for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:04 -0500 Received: by mail-wm1-x332.google.com with SMTP id f3so9726724wmj.4 for ; Thu, 07 Mar 2019 07:25:03 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.25.01 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:25:01 -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=4aqoXklyo8jbkYG/o4RryUcdEE4iG+JVJh6U5yHsgeM=; b=yFAc2O3qUtItsJw/c8IXqgDGRYIq6wKhD2tTFPe3tfzE6UtYOxeCW59VHUHr796QeW d2zKKMNfk6qiqStjk7ioKpAEr4qd7W4bICAvyOL4tSh9lOW1IzKzuAukBz7EzGPCTeuI iY/vSoTYvyH7yt+3HCew0/0w/iocKL8IE+v5bmSs8IZiUKnHLnp8/qxDEUl+eerp0ljN 5u091KNrDcOqegi5ErpGYwEV3jQgjD7WG2mKsOsOBzOsWb48JeA9mj42aWUJwOBP1Gle WFQuIuHUDdCETqOIHy3sRYN/6LqWRauEsnwBx1s9cjvRkI2c/E4ohPKeUxCRYAhQHZVR rL2Q== 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=4aqoXklyo8jbkYG/o4RryUcdEE4iG+JVJh6U5yHsgeM=; b=eAPj0yxceY5GAdzUi24KYMDd26MtfBplAGqMzr4vW+tuvudfWhmVDn23wDnQ4fEFyJ M999yAjtfbrZub0BE+H06UZaTlV+oIQqZHWhi41yjll0Bb1ybO7RrpRyiVBJeYLaupbl sIlLkurPVI2COb2y6RrR4HsP6FiNBh+OMsABmP8UrQuuckVOBWPEOXwrTwkqgOUENlvZ Dn+c6hXHOVA7EBcTFGdmhFTzdHDRiuEU5cgAy5hPKvLVQn1+wL0FSLgpX9Her9NlifZt 71d+Nkm4LD2cjzmxqgp34/ddWeITAyXvw63TB7mY1Pdmm52p2JlrSx7zVQmSuoQqN9+0 xYWw== X-Gm-Message-State: APjAAAXSbaof+k9l5f97zGwxFIZbHLEzdISGoF/okoGlgHEek6iTN8dN 6n2SIMb6s+3T2+swdn2d3wpCfMrBGs4= X-Google-Smtp-Source: APXvYqy0WOG3FGrYgAydvVSTC7W2E/uCoZY7wUJGnHGZk5KH475Oz6Pt5PAt+8ErsItUU3BhdTxWsg== X-Received: by 2002:a1c:c019:: with SMTP id q25mr5922517wmf.113.1551972302427; Thu, 07 Mar 2019 07:25:02 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:47 +0000 Message-Id: <20190307152450.20340-10-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::332 Subject: [Qemu-devel] [PULL 09/12] Makefile, configure: Support building rST documentation X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Add support to our configure and makefile machinery for building our rST docs into HTML files. Building the documentation now requires that sphinx-build is available; this seems better than allowing half the docs to be built if it is not present but having half of them missing. (In particular it means that assuming that distros configured with --enable-docs they'll get a helpful error from configure telling them the new build dependency.) Signed-off-by: Peter Maydell Reviewed-by: Philippe Mathieu-Daud=C3=A9 Tested-by: Philippe Mathieu-Daud=C3=A9 Acked-by: Aleksandar Markovic Reviewed-by: Richard Henderson Message-id: 20190305172139.32662-10-peter.maydell@linaro.org Message-id: 20190228145624.24885-10-peter.maydell@linaro.org --- configure | 15 +++++++++++++-- Makefile | 45 ++++++++++++++++++++++++++++++++++++++++++--- .gitignore | 1 + 3 files changed, 56 insertions(+), 5 deletions(-) diff --git a/configure b/configure index cefeb8fcce4..47bf617fcc5 100755 --- a/configure +++ b/configure @@ -4589,13 +4589,24 @@ if compile_prog "" "" ; then syncfs=3Dyes fi =20 +# Check we have a new enough version of sphinx-build +has_sphinx_build() { + # This is a bit awkward but works: create a trivial document and + # try to run it with our configuration file (which enforces a + # version requirement). This will fail if either + # sphinx-build doesn't exist at all or if it is too old. + mkdir -p "$TMPDIR1/sphinx" + touch "$TMPDIR1/sphinx/index.rst" + sphinx-build -c "$source_path/docs" -b html "$TMPDIR1/sphinx" "$TMPDIR= 1/sphinx/out" >/dev/null 2>&1 +} + # Check if tools are available to build documentation. if test "$docs" !=3D "no" ; then - if has makeinfo && has pod2man; then + if has makeinfo && has pod2man && has_sphinx_build; then docs=3Dyes else if test "$docs" =3D "yes" ; then - feature_not_found "docs" "Install texinfo and Perl/perl-podlators" + feature_not_found "docs" "Install texinfo, Perl/perl-podlators and p= ython-sphinx" fi docs=3Dno fi diff --git a/Makefile b/Makefile index 2208bde4196..add22cf2947 100644 --- a/Makefile +++ b/Makefile @@ -388,7 +388,7 @@ dummy :=3D $(call unnest-vars,, \ =20 include $(SRC_PATH)/tests/Makefile.include =20 -all: $(DOCS) $(TOOLS) $(HELPERS-y) recurse-all modules +all: $(DOCS) $(if $(BUILD_DOCS),sphinxdocs) $(TOOLS) $(HELPERS-y) recurse-= all modules =20 qemu-version.h: FORCE $(call quiet-command, \ @@ -637,6 +637,14 @@ dist: qemu-$(VERSION).tar.bz2 qemu-%.tar.bz2: $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2= ,%,$@)" =20 +# Note that these commands assume that there are no HTML files in +# the docs subdir in the source tree! If there are then this will +# blow them away for an in-source-tree 'make clean'. +define clean-manual =3D +rm -rf docs/$1/_static +rm -f docs/$1/objects.inv docs/$1/searchindex.js docs/$1/*.html +endef + distclean: clean rm -f config-host.mak config-host.h* config-host.ld $(DOCS) qemu-options.= texi qemu-img-cmds.texi qemu-monitor.texi qemu-monitor-info.texi rm -f config-all-devices.mak config-all-disas.mak config.status @@ -657,6 +665,9 @@ distclean: clean rm -f docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html rm -f docs/qemu-block-drivers.7 rm -f docs/qemu-cpu-models.7 + rm -f .doctrees + $(call clean-manual,devel) + $(call clean-manual,interop) for d in $(TARGET_DIRS); do \ rm -rf $$d || exit 1 ; \ done @@ -690,7 +701,18 @@ else BLOBS=3D endif =20 -install-doc: $(DOCS) +define install-manual =3D +for d in $$(cd docs && find $1 -type d); do $(INSTALL_DIR) "$(DESTDIR)$(qe= mu_docdir)/$$d"; done +for f in $$(cd docs && find $1 -type f); do $(INSTALL_DATA) "docs/$$f" "$(= DESTDIR)$(qemu_docdir)/$$f"; done +endef + +# Note that we deliberately do not install the "devel" manual: it is +# for QEMU developers, and not interesting to our users. +.PHONY: install-sphinxdocs +install-sphinxdocs: sphinxdocs + $(call install-manual,interop) + +install-doc: $(DOCS) install-sphinxdocs $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) qemu-doc.html "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) qemu-doc.txt "$(DESTDIR)$(qemu_docdir)" @@ -841,6 +863,23 @@ docs/version.texi: $(SRC_PATH)/VERSION %.pdf: %.texi docs/version.texi $(call quiet-command,texi2pdf $(TEXI2PDFFLAGS) $< -o $@,"GEN","$@") =20 +# Sphinx builds all its documentation at once in one invocation +# and handles "don't rebuild things unless necessary" itself. +# The '.doctrees' files are cached information to speed this up. +.PHONY: sphinxdocs +sphinxdocs: docs/devel/index.html docs/interop/index.html + +# Canned command to build a single manual +build-manual =3D $(call quiet-command,sphinx-build $(if $(V),,-q) -b html = -d .doctrees/$1 $(SRC_PATH)/docs/$1 docs/$1 ,"SPHINX","docs/$1") +# We assume all RST files in the manual's directory are used in it +manual-deps =3D $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$1/= conf.py $(SRC_PATH)/docs/conf.py + +docs/devel/index.html: $(call manual-deps,devel) + $(call build-manual,devel) + +docs/interop/index.html: $(call manual-deps,interop) + $(call build-manual,interop) + qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@= ") =20 @@ -869,7 +908,7 @@ docs/qemu-block-drivers.7: docs/qemu-block-drivers.texi docs/qemu-cpu-models.7: docs/qemu-cpu-models.texi scripts/qemu-trace-stap.1: scripts/qemu-trace-stap.texi =20 -html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-re= f.html +html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-re= f.html sphinxdocs info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-re= f.info pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.p= df txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.t= xt diff --git a/.gitignore b/.gitignore index b66b7725512..77522561b8e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +/.doctrees /config-devices.* /config-all-devices.* /config-all-disas.* --=20 2.20.1 From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551972688007479.43833462376654; Thu, 7 Mar 2019 07:31:28 -0800 (PST) Received: from localhost ([127.0.0.1]:53877 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1uzV-00087A-0E for importer@patchew.org; Thu, 07 Mar 2019 10:31:25 -0500 Received: from eggs.gnu.org ([209.51.188.92]:34017) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utN-0002hS-N1 for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:06 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utM-0004v4-T3 for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:05 -0500 Received: from mail-wr1-x431.google.com ([2a00:1450:4864:20::431]:42077) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utM-0004uJ-Mm for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:04 -0500 Received: by mail-wr1-x431.google.com with SMTP id r5so17898443wrg.9 for ; Thu, 07 Mar 2019 07:25:04 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.25.02 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:25:02 -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=OnTS4raxef201aydXcnSAQ24k82s5wx58EGznEvtEAc=; b=gDOfOW+mpWzfnZm1naoZSKAWXiYtKhH6lVJkgoKOLS+immEtLJSGPTUx5GVVI5DY4C M+sx9beQda3U29+/YF4r6tuyXy5MncJCplp/pMdsPNRKYXQT3Sa6f441turGEAlNReWa JHlfn36JCXQpfqiOFDZyEbvom5CL2nKf8k/U21qxvuBkdZ+S3cWqNz/H+epUm/5A2zDg 32xcjCPAcWc42BoqSw/KIrEgKxeMCBkIX9Ycqi8+HQnSxt9SIAzOc74R6BNFQd04WGVI r+pbF06i7VPHYd6TUYdf5FjPwtio0RGA/kT6nuLu6MOO+MYucrRnn+N6CsZ3csYpzWBD KWsQ== 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=OnTS4raxef201aydXcnSAQ24k82s5wx58EGznEvtEAc=; b=MrxXs0QpzhoufCN7JCwWCOvMhioQfNxtXcubXHffnq4KZeigw/s0jw3/GjSnqJMYuG LobPRO0FkrbRCb6JrNSZJ+cQfx4LosJzS/Nb/DuMM8n6k4zupZIZCeYjIz7cdL+1eYCF 3TskX55DWqxPFp3z70a7W9cHBiVHEbHZxCvZcwXN2DoykLtKsk1ZA0pium+JmyW3oRF4 AOexX8vp5xgEFuZEICpkwdGbi6IWaNpSmaPQt5LHrVenNmtW0Eo/TZmAAXHrwFw8KjCp cyDFkbE/LrMC2TvwJ1HooAHr9Bm5eigBH/IUbT0Xyk8Z4SG5VwYG/8UEQVOduQvPtIwZ fxzg== X-Gm-Message-State: APjAAAVAVlHpdGiDilcUVJiUVUOukRnQzQuls2f1U5XKU9kVZ1PQ2DkT ViFFwu2aiLsGjbuBx5t8yWTQR5dlw+Y= X-Google-Smtp-Source: APXvYqypWyaHQmTParvtMNfhiyE4qcVvpUcB93a1iktEL0dqc9k9d+QwHQBep3+Jse+quBa54+vD7w== X-Received: by 2002:adf:dfca:: with SMTP id q10mr7471748wrn.45.1551972303437; Thu, 07 Mar 2019 07:25:03 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:48 +0000 Message-Id: <20190307152450.20340-11-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::431 Subject: [Qemu-devel] [PULL 10/12] Makefile: Abstract out "identify the pkgversion" code X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Abstract out the "identify the pkgversion" code from the rule for creating qemu-version.h, so it sets makefile variables for QEMU_PKGVERSION and QEMU_FULL_VERSION. (We will want to use these when building the Sphinx docs.) NB: As we abstract this out, we use -e to check for .git rather than -d, since in some situations .git may be a file rather than a directory. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Acked-by: Aleksandar Markovic Reviewed-by: Richard Henderson Message-id: 20190305172139.32662-11-peter.maydell@linaro.org Message-id: 20190228145624.24885-11-peter.maydell@linaro.org --- Makefile | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/Makefile b/Makefile index add22cf2947..b746d112a7f 100644 --- a/Makefile +++ b/Makefile @@ -87,6 +87,20 @@ endif =20 include $(SRC_PATH)/rules.mak =20 +# Create QEMU_PKGVERSION and FULL_VERSION strings +# If PKGVERSION is set, use that; otherwise get version and -dirty status = from git +QEMU_PKGVERSION :=3D $(if $(PKGVERSION),$(PKGVERSION),$(shell \ + cd $(SRC_PATH); \ + if test -e .git; then \ + git describe --match 'v*' 2>/dev/null | tr -d '\n'; \ + if ! git diff-index --quiet HEAD &>/dev/null; then \ + echo "-dirty"; \ + fi; \ + fi)) + +# Either "version (pkgversion)", or just "version" if pkgversion not set +FULL_VERSION :=3D $(if $(QEMU_PKGVERSION),$(VERSION) ($(QEMU_PKGVERSION)),= $(VERSION)) + GENERATED_FILES =3D qemu-version.h config-host.h qemu-options.def =20 GENERATED_QAPI_FILES =3D qapi/qapi-builtin-types.h qapi/qapi-builtin-types= .c @@ -392,23 +406,8 @@ all: $(DOCS) $(if $(BUILD_DOCS),sphinxdocs) $(TOOLS) $= (HELPERS-y) recurse-all mo =20 qemu-version.h: FORCE $(call quiet-command, \ - (cd $(SRC_PATH); \ - if test -n "$(PKGVERSION)"; then \ - pkgvers=3D"$(PKGVERSION)"; \ - else \ - if test -d .git; then \ - pkgvers=3D$$(git describe --match 'v*' 2>/dev/null | tr -d '\n');\ - if ! git diff-index --quiet HEAD &>/dev/null; then \ - pkgvers=3D"$${pkgvers}-dirty"; \ - fi; \ - fi; \ - fi; \ - printf "#define QEMU_PKGVERSION \"$${pkgvers}\"\n"; \ - if test -n "$${pkgvers}"; then \ - printf '#define QEMU_FULL_VERSION QEMU_VERSION " (" QEMU_PKGVERSION ")"= \n'; \ - else \ - printf '#define QEMU_FULL_VERSION QEMU_VERSION\n'; \ - fi; \ + (printf '#define QEMU_PKGVERSION "$(QEMU_PKGVERSION)"\n'; \ + printf '#define QEMU_FULL_VERSION "$(FULL_VERSION)"\n'; \ ) > $@.tmp) $(call quiet-command, if ! cmp -s $@ $@.tmp; then \ mv $@.tmp $@; \ --=20 2.20.1 From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551974584075233.10316144853186; Thu, 7 Mar 2019 08:03:04 -0800 (PST) Received: from localhost ([127.0.0.1]:54470 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1vU1-0001Hw-Tw for importer@patchew.org; Thu, 07 Mar 2019 11:02:57 -0500 Received: from eggs.gnu.org ([209.51.188.92]:34050) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utQ-0002kO-14 for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:09 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utN-0004vl-Rc for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:07 -0500 Received: from mail-wr1-x430.google.com ([2a00:1450:4864:20::430]:46284) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utN-0004v8-Kg for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:05 -0500 Received: by mail-wr1-x430.google.com with SMTP id i16so17881169wrs.13 for ; Thu, 07 Mar 2019 07:25:05 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.25.03 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:25:03 -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=1YApA52i18Nn/0msmBFdz83XJVVSHcLDg1SnWzTelNI=; b=qeohnpHoyp/ro6rK1GLHBce1p5A3LmWCjBm3pAqO5ZT8cBxmu4CHXKSJkTgN5c6nel UIzHcf2GYQ/MEVXV5XsSgwFzrFo4XqtfMfMUlJKjj0tpdM2DprhpO1mTQivuKmNXF5lg cXku/jLYWOn7M+e2BHqj1BtCTN2VlS0KsDrPhInMW5X8CnauMFn2RYodORbcnK1AecCM oBJ1kEP80B/WP3PPWwmR7SG7zFxG53o4/gjPqFDjYEHFNfhKMjmFXQe5jOnmXljXRHT2 jPXUsL/0iQ0sfdc+lC4vBjbtAbfXJrFeLTiAk3vdCqfNhY1GihXHKN7JQ0rcHnJDdzsD gtWw== 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=1YApA52i18Nn/0msmBFdz83XJVVSHcLDg1SnWzTelNI=; b=XnpjffQrSklG09ZPxIUFNphvHJA/cMXKuftDrbtdYAC4XcWa97m8ECaCvD7DMKgeJp tjmBD2P4sJk4jN0J0vmiomUqsNj1tZwikhZR1YXf4dT6DIOdZzQcd7FVBJhuu4NxrbJC W5at7I/atJjmroEOdR3kE95fjkLou1tgVmPL/Tyo/wVmUkmwllDSikbISOZxHi8QqHVW Pm86hnGfPCwPSr7Pq3z5eqyqPdSm2TppbIslnos9xtRvUfC4CVMCEiz0fZoO+U9kO3t/ pFiBk72jEP/OkeK6JbO6piIUprRQjbBC3VK9CSbOibs4SUaObbaywrT/MrN/uw7KCjhC vN4w== X-Gm-Message-State: APjAAAWPNdf0FSDQE27PYa2+dHkFBx48w2GFkCOXDiD89ZV8KhA5Ds4a 18Y0ciALYK35fFwo+jYDYq7zegIajbs= X-Google-Smtp-Source: APXvYqxRxqdCG9FNfTEr/1sMrqnyNVd8zCXBhJ8/6UC5OJOaMQ9IJtom+DuaxH86FO0TocjPtQbSnA== X-Received: by 2002:adf:e5cc:: with SMTP id a12mr7839692wrn.130.1551972304409; Thu, 07 Mar 2019 07:25:04 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:49 +0000 Message-Id: <20190307152450.20340-12-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::430 Subject: [Qemu-devel] [PULL 11/12] docs/conf.py: Don't hard-code QEMU version X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Don't hard-code the QEMU version number into conf.py. Instead we either pass it to sphinx-build on the command line, or (if doing a standalone Sphinx run in a readthedocs.org setup) extract it from the VERSION file. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Reviewed-by: Philippe Mathieu-Daud=C3=A9 Tested-by: Philippe Mathieu-Daud=C3=A9 Acked-by: Aleksandar Markovic Reviewed-by: Richard Henderson Message-id: 20190305172139.32662-12-peter.maydell@linaro.org Message-id: 20190228145624.24885-12-peter.maydell@linaro.org --- Makefile | 2 +- docs/conf.py | 21 ++++++++++++++++----- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index b746d112a7f..cad585b4d6b 100644 --- a/Makefile +++ b/Makefile @@ -869,7 +869,7 @@ docs/version.texi: $(SRC_PATH)/VERSION sphinxdocs: docs/devel/index.html docs/interop/index.html =20 # Canned command to build a single manual -build-manual =3D $(call quiet-command,sphinx-build $(if $(V),,-q) -b html = -d .doctrees/$1 $(SRC_PATH)/docs/$1 docs/$1 ,"SPHINX","docs/$1") +build-manual =3D $(call quiet-command,sphinx-build $(if $(V),,-q) -b html = -D version=3D$(VERSION) -D release=3D"$(FULL_VERSION)" -d .doctrees/$1 $(SR= C_PATH)/docs/$1 docs/$1 ,"SPHINX","docs/$1") # We assume all RST files in the manual's directory are used in it manual-deps =3D $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$1/= conf.py $(SRC_PATH)/docs/conf.py =20 diff --git a/docs/conf.py b/docs/conf.py index f452e424cfe..befbcc6c3e1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -76,11 +76,22 @@ author =3D u'The QEMU Project Developers' # The version info for the project you're documenting, acts as replacement= for # |version| and |release|, also used in various other places throughout the # built documents. -# -# The short X.Y version. -version =3D u'4.0' -# The full version, including alpha/beta/rc tags. -release =3D u'4.0' + +# Extract this information from the VERSION file, for the benefit of +# standalone Sphinx runs as used by readthedocs.org. Builds run from +# the Makefile will pass version and release on the sphinx-build +# command line, which override this. +try: + extracted_version =3D None + with open(os.path.join(qemu_docdir, '../VERSION')) as f: + extracted_version =3D f.readline().strip() +except: + pass +finally: + if extracted_version: + version =3D release =3D extracted_version + else: + version =3D release =3D "unknown version" =20 # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. --=20 2.20.1 From nobody Thu Nov 14 06:53:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551974713559228.3851886383635; Thu, 7 Mar 2019 08:05:13 -0800 (PST) Received: from localhost ([127.0.0.1]:54483 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1vW3-0002Z8-HD for importer@patchew.org; Thu, 07 Mar 2019 11:05:03 -0500 Received: from eggs.gnu.org ([209.51.188.92]:34086) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utU-0002sR-Jw for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:13 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utP-0004wp-0D for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:12 -0500 Received: from mail-wr1-x42a.google.com ([2a00:1450:4864:20::42a]:37310) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utO-0004vz-P2 for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:06 -0500 Received: by mail-wr1-x42a.google.com with SMTP id w6so17898515wrs.4 for ; Thu, 07 Mar 2019 07:25:06 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.25.04 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:25:04 -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=n4qgWlMbkh+DX58XPQOhG1B/SfrocdZejGZYPEYaKCs=; b=a8IFUqh9tQI2XAXO5dJ4+9O7Fr7DfG/HSJa98aVwylMlr5Q/joG8HsDhYK3jconV7s TODvxGuENmfbU59GI6ox8AuQNWvgvdnCVSTMfLYIpq24wZjI+COueBJ3Hx7a3j3u5kH7 lunMkyfmlSM3bUs/J0Q2Wr1ZHk0CzoapqOFajaxkhjpN7f001LBtQiyUakfOQetkEi8M ix8gdaT92uqo9RY5hl75ACBCsLw+F+9lHIEfLWw3G/fNK6idH46W9Ri1KRl2Yd4iNBG0 +904RO/s2SwuSEkADa0FxFq6AGaTeqINvVHSJnXuY3WODHpCBLoEgupyW3/ABC0o2lf5 2qLQ== 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=n4qgWlMbkh+DX58XPQOhG1B/SfrocdZejGZYPEYaKCs=; b=DQT+aQaEmJ6kFZQOlu+qDmIxvso1VjlFnaPzG2574urvY5xYwj3rI//bIMgjh57b3D /QjJORxvVu61SJQL0lTdwLL3tLR9UMHY7YyplyVEf8CUtAQVA3+nAJPSxmHa/70eDA5p 7YtVZM873+Af0jYilEEzRLphLtinG8Fcd33+dWEp7EHF9Je2J2noVau3ovBYzD7hpdrE QpV6mJu+msSRfONXeAa6VKxtI651wJt/rPdKUZ4B5ZQUDZK/60x1nssfhhZCl2mVYZd5 +dh/sBh/wMqisZzeohPSEgt0fwlUE+rVB+y6GKHfNXSwF3gOtlSwyVtGVPq9iptUEEU9 ByLA== X-Gm-Message-State: APjAAAUuorcGQ2b+JFMjA0m/W+iIB+Ows8eKtrG+FWiJ67qMz/LAtGpP J7s4+QnjOyjEKneB7f3TiM2M/+GSdcE= X-Google-Smtp-Source: APXvYqx9vJ2ZhNNVFjMXhDQiLCl3cjXFnArnrgIXNAAn4iWgZ1X72RCvmhCoyXr9GJpXjgIHsr1dAw== X-Received: by 2002:adf:fdc3:: with SMTP id i3mr6919706wrs.252.1551972305507; Thu, 07 Mar 2019 07:25:05 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:50 +0000 Message-Id: <20190307152450.20340-13-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42a Subject: [Qemu-devel] [PULL 12/12] MAINTAINERS: Add entry for Sphinx documentation infrastructure X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Add a MAINTAINERS entry for Sphinx documentation infrastructure: this doesn't cover actual content, only the machinery we use to build the docs. Signed-off-by: Peter Maydell Reviewed-by: Philippe Mathieu-Daud=C3=A9 Reviewed-by: Richard Henderson Message-id: 20190305172139.32662-13-peter.maydell@linaro.org --- MAINTAINERS | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index 5040d9dfb12..074ad46d473 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2567,3 +2567,9 @@ GIT submodules M: Daniel P. Berrange S: Odd Fixes F: scripts/git-submodule.sh + +Sphinx documentation configuration and build machinery +M: Peter Maydell +S: Maintained +F: docs/conf.py +F: docs/*/conf.py --=20 2.20.1