From nobody Thu May 2 11:24:45 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 155180664540137.86046663922946; Tue, 5 Mar 2019 09:24:05 -0800 (PST) Received: from localhost ([127.0.0.1]:46436 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DnK-0003On-BU for importer@patchew.org; Tue, 05 Mar 2019 12:23:58 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35471) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlC-000260-0z for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:47 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlB-0000Qa-57 for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:45 -0500 Received: from mail-wm1-x32b.google.com ([2a00:1450:4864:20::32b]:51247) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlA-0000KV-UB for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:45 -0500 Received: by mail-wm1-x32b.google.com with SMTP id n19so3358051wmi.1 for ; Tue, 05 Mar 2019 09:21:44 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.42 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:42 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=G9EFylNXe34RQZQSo/UwiJzoZ9HtkVUMgBIkYDaPROs=; b=wAIZhQORGBbBH3+hgLWb/n2dcAd0C5vVsLiZyQ0KyiF5EYgTe1vJ38iyAAr5Z473bn udN5gwFx2BtrbGkbwNf+9hd1X1h56zIWiYFPZeEIDAsoykhQbEmlUYM5SoKrs7rEXfqN iIAJTvZHtOtj91n5cwASFSkCJvStPC/bgIRubnsF8nUwc/2LXEbmlJbo9jYJ5rTdHaEb 6d2ShM0pLmHECSfNNjA+B/1phyKAmAgeLR+dPkNIgITVXZLCbj9YmXZWImkfphMO03E4 OQSdfrNvuVUrfOJB6RFnrkUxcPTg0QV0mr6ZENFpn20p3fiUtND0ZWB/ehIQLMYJxEvz ncAQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=G9EFylNXe34RQZQSo/UwiJzoZ9HtkVUMgBIkYDaPROs=; b=rnCjc5Y8hRJ1AMF3b/64/+7BwPkCB7sJwrfQOA0aHTjbav20ne6dindOQgtS1IL3US 2Td0jvre2NpbFiBwy0ZmdhRBk74Eb69dxptpJBjngBCqTTyHHy75bOL+HVY10+C7me8P 046mZ47KBxbD4GojxvJSKGBD9NL6wRPKPJ1NoWH2DyGGOAVLZno2K5bWYzhRsf7ro9wK fzuf8YDZV6stbj6Qh+0O32fPNONWbx1y3ZTld87Wvr2sJgj7YrAHBMGrU45IiyOyWOns B1MNur+VE4cWhZzezApHpc5+F/l1TP+YCn3p6eNGSMz+xn//2+wACIo4ThL2WVqpgcU1 NwxQ== X-Gm-Message-State: APjAAAVEGv6fD3fktYsnGr1Vrcv0D3waad14uQk+WOwtpw9CnU7cFZvA mmIAb9f05ycN3/syYkQ500Zsiz6ociM= X-Google-Smtp-Source: APXvYqwc5wor0jbF/qQ/kypJB/sU6pZtd44F0gyWF2X8AJemy+rNNH/2EqnBcDnaK4oTzxvmFBVIVA== X-Received: by 2002:a1c:cc0c:: with SMTP id h12mr3736726wmb.140.1551806503408; Tue, 05 Mar 2019 09:21:43 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:28 +0000 Message-Id: <20190305172139.32662-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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 Message-id: 20190228145624.24885-2-peter.maydell@linaro.org Reviewed-by: Cleber Rosa Reviewed-by: Richard Henderson --- 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 1c268e00b41..e2d4e893b01 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 May 2 11:24:45 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 1551806845405664.0945192291118; Tue, 5 Mar 2019 09:27:25 -0800 (PST) Received: from localhost ([127.0.0.1]:46530 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Dqb-0006VL-S7 for importer@patchew.org; Tue, 05 Mar 2019 12:27:21 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35496) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlE-00028S-II for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:50 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlD-0000Yi-1L for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:48 -0500 Received: from mail-wr1-x443.google.com ([2a00:1450:4864:20::443]:47090) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlC-0000U0-MF for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:46 -0500 Received: by mail-wr1-x443.google.com with SMTP id i16so10341457wrs.13 for ; Tue, 05 Mar 2019 09:21:46 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.43 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:44 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=wpBH3UVWa5xs78E58hfC7XY52d6PFrvdK5V9hk6kivY=; b=SP86LY0V5SFSgnfL45AyAhp2C0qFhvV3fiJ2Wz983C0Q4Xwqi4xm++mGF4soebarEa ypAcCCRxKNWwFleVs28DFJ/4b4BE5eCMIG88ww4W8KZtZG8CgJouJepXkktemIU5C2Zg 6lz/SFD+dC7gzVJMzs9VmnJTHGTOSsO/dnH89l5n++G8RIdMklI8pmEhdGTK4uJqdOLF gjZNk+nXtoxa4+Nsn1oDQcsf/28bdUrVhfPSk/jds2sv0Zhn80+aTcCIhPxiaw9m99dJ ZU2eAWPU9CQWzNT4fqN5FU9BWFihVdtqptlok2BhSAaczTsWxQaH9GJECjKOzlUb+7B+ ltOw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=wpBH3UVWa5xs78E58hfC7XY52d6PFrvdK5V9hk6kivY=; b=iO4yNyIctSj4SxI2sxOTi1r96/YmbHEl6KxLkKOe8Ni8/BUFOo1A3e3J1qZ4YcfpfW RWdw9vgOP13Y8Nm+EOcHBnSzH2/hdjx+kEJ6ZM4gWmmv4KU+XGaVzn6pmnd66t2+Q3TC iH60cEZaRJQVNZRtoeUweeNHdDQXlM1uExA6AK+iJMe4SAH4jaQBLAlDhA1nB2G4UNhV IObtluudjN+i2/pPzqmySIBwnWFgKAeLTwhKOIKdbS18ANhelIwmQxKbRyEZNxzT9Syk SakbLALzOvh3FTwM/h65fgsSDY2WDDKr1SJp1llRIPAA9YZh0qeXZyuTjkrEYa6CNMrd qfIA== X-Gm-Message-State: APjAAAWB12qu0szr2ewYVM9ytYxdGgEwml9ThbfJRAzXGPylRtAvvpn+ D1pRAbSRWcfxYmkOPXbwVK3QwHo4YRE= X-Google-Smtp-Source: APXvYqxDyCqE4ALfXb13yFrptPdpyrSMttb1u224/6nFNNWzQbXbGXpEc4+6eeKUy1ITjQOHfWrtBg== X-Received: by 2002:a05:6000:1084:: with SMTP id y4mr2292wrw.14.1551806504775; Tue, 05 Mar 2019 09:21:44 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:29 +0000 Message-Id: <20190305172139.32662-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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::443 Subject: [Qemu-devel] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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 Message-id: 20190228145624.24885-3-peter.maydell@linaro.org Reviewed-by: Cleber Rosa Reviewed-by: Richard Henderson --- 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 May 2 11:24:45 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 1551806852603969.5760723634005; Tue, 5 Mar 2019 09:27:32 -0800 (PST) Received: from localhost ([127.0.0.1]:46532 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Dqi-0006dD-Gb for importer@patchew.org; Tue, 05 Mar 2019 12:27:28 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35504) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlF-00029F-6T for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:50 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlD-0000bj-TK for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:49 -0500 Received: from mail-wr1-x441.google.com ([2a00:1450:4864:20::441]:36619) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlD-0000YU-MJ for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:47 -0500 Received: by mail-wr1-x441.google.com with SMTP id o17so10377685wrw.3 for ; Tue, 05 Mar 2019 09:21:47 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.44 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:45 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Hcmr58/vFQKeFxBv45zNtbUyT6GOSIfsDz+3Rdf8Xck=; b=p3THOfPn1xbP/8kcFkRWESr9XIei0FdEJsZANBYeSotzfM0wiebSCUG5zQrCG9N6wU SHfAE6jJiRu8vZMzIMXrU1e5D9veBQNGmrvoQeLSDDLW1vUkDbg9WG7F9oTCnDIaoG2w EQ+8xU+HkZ33Jf92BPg6qNc8TM0IzSLNvWrXxvYd2sjdvkKl78/wQmAv7xuEjxIGRqOW lkb11sFZWc+jMdw+3WdAC9/dYvMLSE1SZDxNlDF/t9QDRaalCRRo6ij/khDDr8Ys4qht tbtgZ9hbrE+OiJMAUkftMz+EezSnX+OwKs7XrVnyFqcrMdU5VIBVxCJNSmCZESnm+q1Q pEWA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Hcmr58/vFQKeFxBv45zNtbUyT6GOSIfsDz+3Rdf8Xck=; b=Ms1L9kxM4N/BYM7KEgU7h5d+Zz+MW5CGbYsefEvufrzOiK2md2FV7PmWfHTnfWnKRM W5PWGOlRE6u4i5UHBCV0XhJaZJbT3p2lxlwlBtU5BLs436EN9PvdxVwrLlDpu1YoFIYs QEwYenn8LGxksCPEPT1XUxgg4AZ+hobPLAaLO5kxGG78+m3BdT7DQxxKzWeS/2vY/5PA UUaonp6ppsiDOPp62kd24lcbaEOeLwqlXlZdgKUzshMEmJ6Fqhgp6lCAqqomevMjxqs/ QHew/ebmLC6W5tzllApQxFQ8BN2y1hV02Gio8mhdqWb9/V0y/fZ7u6B7LTNQdd1ZpfYQ 4ptA== X-Gm-Message-State: APjAAAV5OSJsWk9JEwN0A87AcQeTsl6eMtFrhYAh1wbE7RAxvQUojgKe +yVmNdaUN7Q1GpNlK6tJo42ANdQC1C4= X-Google-Smtp-Source: APXvYqy28bKRYxf7JphLrmg9d25dqBtkGI5kgKl3NULwJvN0S1KbitGgxPTWJcAnYW7IlyuOA7hJDw== X-Received: by 2002:adf:fd46:: with SMTP id h6mr16781547wrs.170.1551806506205; Tue, 05 Mar 2019 09:21:46 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:30 +0000 Message-Id: <20190305172139.32662-4-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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::441 Subject: [Qemu-devel] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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 Message-id: 20190228145624.24885-4-peter.maydell@linaro.org Acked-by: Richard Henderson --- 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 May 2 11:24:45 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 1551806874728930.1877800324029; Tue, 5 Mar 2019 09:27:54 -0800 (PST) Received: from localhost ([127.0.0.1]:46534 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Dr6-0006v1-IK for importer@patchew.org; Tue, 05 Mar 2019 12:27:52 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35524) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlF-00029k-Oy for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:50 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlF-0000gz-10 for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:49 -0500 Received: from mail-wr1-x42c.google.com ([2a00:1450:4864:20::42c]:43301) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlE-0000cG-Pd for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:48 -0500 Received: by mail-wr1-x42c.google.com with SMTP id d17so10362140wre.10 for ; Tue, 05 Mar 2019 09:21:48 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.46 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:46 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=oJaVF8BUp6ymfY8LQ5ejKFv+zG/bV2ot9FpO3HIaIog=; b=APfphyy2gqcGm2SSN29HPDKpr+9fx+S9+4aN7F+lpoJaCgHJkMUpCEZLr44Zyq6TVh CPEzHVoV72CjssOe7nRjVeYzw8UWGQfHbD98Ojl+nTgbBtYkIxEoTnVL5YcLvzGh12P6 Mdq58bsidqVYZffZKqTFbDlCDg2DAImaq7wu7/4LWHVVFyoqD6TqdLxUNMSFLesWgM61 SYFfS/59eBaNBPfeNwYqbWkOG139ZiMaqLiQ6lnNBQkXXYXs3bbLhYT4kcel/Jr/NbP4 ahyyTELPxPerXXCWzBUaQA9UBGR354ty+K/VuxhKhpyTWIAo6NH6/7gctNJoP8B/yilP gwdg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=oJaVF8BUp6ymfY8LQ5ejKFv+zG/bV2ot9FpO3HIaIog=; b=gr9QhMhP+Cymq9RK9voZWf27e5DPDf216Sc7mCS8mZ0lENwwNwsbqzuNfLTpflSeHf W8mVdZd59erMjE2JcqznaSB8p7Qt69W5NUWww9YXwmru8RzFlLDDcuKajZs01zerEs2g S7GCuS5qslFmhNq33O1BRaUvw5L4s7zv+kPgy3QOQDU3CTd4yG0M2HCiUNuG+F58yJtl LDTARfzt12Wcy+ZeUg3GWPz1yUvzrwhHuF3X6T6SsHzONvp4cWIxtsY6EH/kaaEvVaNk UegoK5fYPjpTCge/tUMbJpwKPrkgGvTLfe/Moe9C2OvD9gUpUindiCshHN6ABaEOtuiP LPrA== X-Gm-Message-State: APjAAAVVywYD+HD84K4uejceRoasqctkRXg82613BRBWycAEuItyzRJj oBj345X3AN6QJ9MOLPpB27efUGs4uk4= X-Google-Smtp-Source: APXvYqyaWHAbJHlKUDwqTfBKYMJ2dhct2jLCrHiYqHjUf7RY4zLgR+ewLth2YMCgeXnZnUOqntBiJg== X-Received: by 2002:a5d:4605:: with SMTP id t5mr16788880wrq.311.1551806507464; Tue, 05 Mar 2019 09:21:47 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:31 +0000 Message-Id: <20190305172139.32662-5-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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::42c Subject: [Qemu-devel] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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 Message-id: 20190228145624.24885-5-peter.maydell@linaro.org Reviewed-by: Richard Henderson --- 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 May 2 11:24:45 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 1551807002112426.48136705362265; Tue, 5 Mar 2019 09:30:02 -0800 (PST) Received: from localhost ([127.0.0.1]:46566 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Dt6-0000I6-GK for importer@patchew.org; Tue, 05 Mar 2019 12:29:56 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35543) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlH-0002B9-98 for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:52 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlG-0000o2-E9 for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:51 -0500 Received: from mail-wr1-x42e.google.com ([2a00:1450:4864:20::42e]:43303) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlG-0000iu-7M for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:50 -0500 Received: by mail-wr1-x42e.google.com with SMTP id d17so10362219wre.10 for ; Tue, 05 Mar 2019 09:21:50 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=adjvDY4ZAfEy3ZZCwY3KFl2vWubKI5IVVVGcqYgy1ds=; b=Il+z//waT/HeeFV58bceYmWlf21ltaMZaS1ZZyRuF79YwnkiNG/jv1b2tqKP5nPh6+ SXYLztK1GejX0ES2uUxEkzFuaJ3zIiavLm9b/MRdKZlONJNeGOUG1/1U0E4cB2s8o7jL WtuH2+GTKM0eAWabBQNco0XTZTc6YQZ4XletxEluqjBgbmKhE8s9nAarChBZdu89Mdj0 EEQe14lSdT3HeMtuS0FwGlQsJWoQhCpvuTx/96MYLx6jgHp/Min7JRmvrBarLq0QkQvZ gRG/Ek0E7bCx9jhzG1KZ1L7u1eUmvXlww26PLzZ/P2M3qgrO5J7Qlie2Axfn1GXT2i8s VfGg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=adjvDY4ZAfEy3ZZCwY3KFl2vWubKI5IVVVGcqYgy1ds=; b=d4l8bIsFgA8RfNxwMrEpnEffrzx6xj0Bo36lYdmCixb1oMDANPRZkD1sXPUNgjlUx2 PcdEJLpfxOM0dE0umU+/5jtr1z1Ax5Yor7SFMZjpxV+oll9gI7EywTfnCbnGsuiJp4NS PshdwCaoBJFl/Yde4trNww8RWz/WCAGKRE5AK2I5RSEj6pUi/XeQO+45DO+fgvcWnhHa xYsQFCOrPnfjy8zD/8o9fHd099H1HmVyA6xI4JeWo66lU1mzmSEXC6W4QjCbfFiK79yZ kQHSCIeGvTVOmATJNr7KZdF2i9dlqi/X4tdmuXcTWTSpP+p/WJ4EUu16xgdrmNMOes/u 7dyw== X-Gm-Message-State: APjAAAXUZ1D10Q429UMwlII8HS/Ov+W3Rak9Ht9SVouaqClw7xozZQGl Zrij+80MGgTUctXtkNEdnbVslYfsSno= X-Google-Smtp-Source: APXvYqzE0Z1VJ+0dcuJ7ryrWBFTPldvHy6cDFDw4C6K+/GncuzGVcL7JaBd/kf84llCb0bfYN8Re2g== X-Received: by 2002:a05:6000:10c9:: with SMTP id b9mr16718497wrx.281.1551806508812; Tue, 05 Mar 2019 09:21:48 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:32 +0000 Message-Id: <20190305172139.32662-6-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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::42e Subject: [Qemu-devel] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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: 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 May 2 11:24:45 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 1551807154371205.12929977572003; Tue, 5 Mar 2019 09:32:34 -0800 (PST) Received: from localhost ([127.0.0.1]:46630 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DvZ-0002FT-52 for importer@patchew.org; Tue, 05 Mar 2019 12:32:29 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35563) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlI-0002BE-Bh for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:53 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlH-0000wS-L2 for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:52 -0500 Received: from mail-wm1-x344.google.com ([2a00:1450:4864:20::344]:50194) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlH-0000pD-Cw for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:51 -0500 Received: by mail-wm1-x344.google.com with SMTP id x7so3369685wmj.0 for ; Tue, 05 Mar 2019 09:21:51 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.48 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=/AzklaR2lW3oTO1kTo5ZJYuiAP+puMVrEbO6mtGy0oo=; b=xYdVZ8FBczwVWp5HjPEf1BYxq2rSfgiaPTA13mkeLkEKEBU9Lx8KsvDBua+9e1s8gE q8J2svpihq7dqmQSo2A52f8kV8+k7rP8VSzXS3l0LbK2zZcuvLBLa+wIXO/gDmjibS9m 13fsnH7leQmX7qYmevLgU/ujz99gJGGdYVTkBB30kjJmj+Ogx3GmlVD1MGsksF9hyHk9 N6S9E34rsz5/GWRw7NnoGk/KiKYWzCz4ahitr/pPs5wvPONR4ebo+ghVhKjYZEfkM/S2 Snf0IouT/WThNjwabAtji7wBofOOfc/YH4pgKfOAfCktCpJMtaB323TVHw7RdLnT5jO4 Bk9w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=/AzklaR2lW3oTO1kTo5ZJYuiAP+puMVrEbO6mtGy0oo=; b=BXc0BNJm+8eob4H6jF4xk6DRcxI5L93JKnUpm7hAcvVtXc3ObKRd6EW5sUw9wAcbW6 P0S6/Z7kzsMEkZR4XIISTLivVEiCmXxMhM+RwoJ2U6a810JbIVPuYO+Ap3FZSn9VakVF a2W9SZpab4lIa8DVyRHefWH8juwVOQihExzvXxttTbT1tKasvawkgka1LV9nePnaJT65 tlg0lNVBYV8I7IIkjocek+CGCjh+OT0+8/nzXCUidcybUlsxrvhoDUKH6vpDovRCPYKz 22KZrlJ97pupvdjsFoKqYCqf7oIv6g0xcV8W2qB04veMkJhsFLyydK6E02zAnMSLxdLh WQMg== X-Gm-Message-State: APjAAAUnUoZmea1QU0/JQLtf67vvaaSpB/2aSvF73ppmW746S77MJ7S7 tG9ysLG/kQZgGll1Ibuvf2ERv1Lpf78= X-Google-Smtp-Source: APXvYqydIepMKjX01KQQP1mQzHDnHi556j0rsXc0qPDQ3l3/clQuGoLy4KZaBH+8glpxFcl2pUGiSg== X-Received: by 2002:a1c:a817:: with SMTP id r23mr3405118wme.110.1551806510090; Tue, 05 Mar 2019 09:21:50 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:33 +0000 Message-Id: <20190305172139.32662-7-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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::344 Subject: [Qemu-devel] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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 Message-id: 20190228145624.24885-7-peter.maydell@linaro.org Reviewed-by: Richard Henderson --- 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 May 2 11:24:45 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 155180731050126.80304836220671; Tue, 5 Mar 2019 09:35:10 -0800 (PST) Received: from localhost ([127.0.0.1]:46650 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Dy4-000436-DX for importer@patchew.org; Tue, 05 Mar 2019 12:35:04 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35591) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlJ-0002CR-Ms for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:54 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlI-00010u-TU for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:53 -0500 Received: from mail-wm1-x329.google.com ([2a00:1450:4864:20::329]:51246) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlI-0000yG-La for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:52 -0500 Received: by mail-wm1-x329.google.com with SMTP id n19so3358504wmi.1 for ; Tue, 05 Mar 2019 09:21:52 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.50 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:50 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=8ij8uYPMGzrIP/UveMA7OLc/n2gSSUxVwM5zQO0bB+I=; b=itiWxSQtTElLvaVfX3OPZn0ip/0xVhjboI3R+5enWmD8x4fBQN1BfvMSNS9oxyu30t nuFGHbDdcPlU9H9ea217MhE7+UprnGTafMnQ7z0P8JDxIW8Ad2sCbVB9jrJyrKAJFEEu xfuVLw3OpU5B8EcL/3k6FN+lu99U0BdGxOoZPBbSzpZWO0yH6OsessVYML+kbParFB7W 6NEb90Q62zvuSfdm9TMgS8ceazVMqWFL+845uSqZf8vnWZHuhKacgbZIs3VrSPHXzVB4 W4i7Q8J4cxzUYgVt45Lh9zO5EIOBl0XYCBtNH73SIWWteyAmhfIhyviIAdakT/hlHkMo VG6w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=8ij8uYPMGzrIP/UveMA7OLc/n2gSSUxVwM5zQO0bB+I=; b=p3pnYU7c3c3zij5/0CDCH49lrPKFg8YhhSGIcinEFsnzim/EADVGlr+qCR90SUdJab MNasLwrWlbuZETWe6eT2ve2s/z3XxOea+nOTZJmP9uNNduT9kKAJb9z5InCY5r6xHh7W /6rOzOUkDNK4Bv4TSW+B6rb8MvK2FCZlS85qiYMTUsd50CjLIrEBzDWuaTXMj1uWIkGa jY0D+udxLKKQw5WOJmhBJCfpjH7yUcdVVn2qmg9xgZNniuAzCFZXWRkuiY1yzKgmzQj9 DDBiT1pXda6Xd//44xONEt18uhUiN/DlokEAnqM9pECRFmxD3/YKgj14LySDH7SNmPgy T/Gw== X-Gm-Message-State: APjAAAX0pe1X4fIyhNBhn1lHiIatdwIbUJfOAECMP/2v/Zg+a3QBOVpb OZ5b1ZQm2j3ZjaeUHYGxLjdlw1/11eU= X-Google-Smtp-Source: APXvYqxV1GRjA1ZOMH7uMiX1ik0Vj7lG9MRzHlNSjJ1/M0GwsItye5vGmqjqvP9pAA29bUHgdUqgZA== X-Received: by 2002:a7b:c74b:: with SMTP id w11mr3360602wmk.79.1551806511405; Tue, 05 Mar 2019 09:21:51 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:34 +0000 Message-Id: <20190305172139.32662-8-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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::329 Subject: [Qemu-devel] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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 Message-id: 20190228145624.24885-8-peter.maydell@linaro.org Reviewed-by: Richard Henderson --- 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 May 2 11:24:45 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 1551807183854748.8796350382806; Tue, 5 Mar 2019 09:33:03 -0800 (PST) Received: from localhost ([127.0.0.1]:46632 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Dw2-0002Zi-3m for importer@patchew.org; Tue, 05 Mar 2019 12:32:58 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35637) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlL-0002Ee-U2 for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:57 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlK-00016b-Ch for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:55 -0500 Received: from mail-wr1-x433.google.com ([2a00:1450:4864:20::433]:39099) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlK-00014W-2U for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:54 -0500 Received: by mail-wr1-x433.google.com with SMTP id l5so10353145wrw.6 for ; Tue, 05 Mar 2019 09:21:53 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.51 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:51 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=01uFVxLCrTIEn1+vZ/yUlBMIWfpbKqcloDaOhKzxQNk=; b=TEgUxys19iWKADB6SixsFnaQGKgcRQRybcCEAnrLMkXzsSYkcNeL0Ykoe11Zz574J5 d9ptni9L9TM9rnaM7Y/oIHGfgoprNgiCnKPFLKeCM4xMc7kRXC5/8C643UjX2tsuO41L iZh/i71+MH9P0KhUQxGp39hPw+95TVlpfoo6sOHvRm4YDdkre6hdZACRaMDKnfxMA6Yu ZFyEQ3s64sDKbOEI4yKkCP7VcGa6MT7DfX8PALDyFcj9oXdemy5ccbRsdZwkUw2L/Om7 EmM6/tRd1jy0uccAS4KKbUYzhBiiP1hMDQerHBcjgm9kG9yjhaH+EgT+xN0zqjTBfMKp pzdg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=01uFVxLCrTIEn1+vZ/yUlBMIWfpbKqcloDaOhKzxQNk=; b=LQOGBXrzGzJeTQuwUswJDUZqGX25m42ZFppdPVlYsNqSrOhyjN/rkQXwKPG1a/q2pI cdjC1Laz+CdavKzehxbkUfKpjk6nZGkL5v3iSn5lXjfJghc2Xeq73WM6VYkvKaXrPo48 3udfYscgLcoucVzIpvCzvGDIqC1yhEELz9XBv1W5DJZ/W4AVGXuO4bxvsqJ4JujpTAaX RbQVh1KGfBG+YsKF3/gsQkev49KJKP2ikpwtj1pbQBAU2L6jA+OBmfajg1l4wNExGZ56 qKSAZX1Pn6dsL0QirlZE1G4CY20dB0M/d5slc5Ly49x0rTGhLopRp5SieEnHVw8dhxlp OsSw== X-Gm-Message-State: APjAAAUO2D4WVwg6BDpLllBsQWZAdb5Iw2Q2eotqKrh8m+j1FiZ10VFo Jgz/poFhP9IGPcq7kLTm4WVy/wIF2nA= X-Google-Smtp-Source: APXvYqxVDlq/fkk5i8wTpM8zQqSx96hUf1H+ZLi7owwHlM5Z+pph21Ip8KF4Lv24Ygdx/GUNKxIBYA== X-Received: by 2002:a5d:6592:: with SMTP id q18mr16464766wru.230.1551806512564; Tue, 05 Mar 2019 09:21:52 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:35 +0000 Message-Id: <20190305172139.32662-9-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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::433 Subject: [Qemu-devel] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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: 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 May 2 11:24:45 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 1551807344104619.3279032901013; Tue, 5 Mar 2019 09:35:44 -0800 (PST) Received: from localhost ([127.0.0.1]:46660 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Dyc-0004Lb-Q1 for importer@patchew.org; Tue, 05 Mar 2019 12:35:38 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35670) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlN-0002GA-2h for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:58 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlL-0001AJ-PK for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:57 -0500 Received: from mail-wm1-x32e.google.com ([2a00:1450:4864:20::32e]:51251) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlL-00017Y-E2 for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:55 -0500 Received: by mail-wm1-x32e.google.com with SMTP id n19so3358618wmi.1 for ; Tue, 05 Mar 2019 09:21:55 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.52 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:53 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=fMSJc4tOcDf53LeHi1yp309x64WCbqGkZGxQnTj7TS8=; b=SlRcq5n/3Mhnd9+iwJ2sJxvqfQq38oXieC0nXqsil5dE9bemw/krV8c8hY7QvBhZeE KAL30CTuO9gIFKIGatS/0qNBptXSDSmAzk7VLoojRwD+ycTlgEYYpuT2im+e1JFZPASm I7nGMQMLBeBBdxYHIrtbCXacoeZFwz1ifwfSGJ1rOLrhTm17TgI4et8eLwp0Gp1p1FXy wzwbQ/gk/QpygsWs4470sQ+l0eUsbxqyl6BKS3qqZOf8TbncY4D9bQgOA1bjIgRmfZD8 3uWgvZNUC+HPGWYCh9C35n322Afv/xk//l2y/fxO/g1+RApWtY6C4H8/c5t578/+a/l7 l2vQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=fMSJc4tOcDf53LeHi1yp309x64WCbqGkZGxQnTj7TS8=; b=CIiGhDJcFrPUFkyj6MDXH5REvfEoGkPgK1pYOQeOs9oanopWrHWdxdzsD3ZlNORIYY qCZakAc1qOrBQWvruel2L090N8Ec85pkqfJxNbaNJzKSi+67Iyj1yZ66g4maVogBplsn nQ65O1AmKBwuK+8nwI8eA/adqfwKGxBQg5foMZO0roU00iNUVy+HvcsdiIiwKROHhNTi MX3Mfo01cV/eDQwfBk2D6kbLxdh1RaZMQTJO64dIE+L+dbK3DPMQ0T1m4SupPTKCSIeO rZmEQVQ1z3k7COnGUKNLMtmh5q4klgd5C8+Pqamx2taohhCXN7cQQ5kAjEPUGwcCfTfU x0RQ== X-Gm-Message-State: APjAAAU6CcSDP7tsv3gvTRIFQAXdbA4P6vo4u+4Hinf57ne2s9FbPLyL X2oKZeI1d4Ch4xKdDro9yGiNle1Auuk= X-Google-Smtp-Source: APXvYqx2wSadHsuA5FEZQ5BhSXTO3PzvqScYuDa8oliYUvFvAMWXzsg29upVAWA4vusDVk5D9kEMAQ== X-Received: by 2002:a7b:c929:: with SMTP id h9mr3445896wml.106.1551806513827; Tue, 05 Mar 2019 09:21:53 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:36 +0000 Message-Id: <20190305172139.32662-10-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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 Message-id: 20190228145624.24885-10-peter.maydell@linaro.org Reviewed-by: Richard Henderson --- 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 May 2 11:24:45 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 1551807499219349.40858839518444; Tue, 5 Mar 2019 09:38:19 -0800 (PST) Received: from localhost ([127.0.0.1]:46711 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1E18-0006fj-8C for importer@patchew.org; Tue, 05 Mar 2019 12:38:14 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35676) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlN-0002Ge-EY for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:58 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlM-0001CK-GT for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:57 -0500 Received: from mail-wr1-x443.google.com ([2a00:1450:4864:20::443]:43869) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlM-0001A1-98 for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:56 -0500 Received: by mail-wr1-x443.google.com with SMTP id d17so10362613wre.10 for ; Tue, 05 Mar 2019 09:21:56 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.53 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:54 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Z84Z1uZ6193RzY2x7LIy2GcmEPEbxZgOCrzhwfmtHHU=; b=S0VjJBvoGJNmC7xOfHj3XSJCWLhl14NyDgcYWGy4hYtfRObpdzv3yE7CBFtvoI/4zu ewXpcFP6Nq/zah0LgJGetUSn6Ii4ei9O6mZapmwPgTUdoHKvPlANeQX/3gxfml0+OTJx TqEu5gBUgufLDe7na38TKQtVvxErVl8J7aLtYyYHwl+Ey/Cqz5GW+xZJnK0LROh1tMhR NxnQtBKa7rssnLPRVHSnEazDg59AWxLdOz2PYcgJLgKqx7zyEVcFLN/DYJAm7gCmZn8E cT0lrPUTEy96Fm94GHrJEGDZD57lUT+9SOb7FwTKFmKIg5eH3v+BTeg5BQoh4qeJNYPs +HIw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Z84Z1uZ6193RzY2x7LIy2GcmEPEbxZgOCrzhwfmtHHU=; b=SpCRFBBClXBAAaE+QkXXhjTegNaQu3ien94TYLQ2mxd74zloi/BVHAIUcu7EduowyU JCUjcz58lN2r56cYzV2wkCGKDIphG2rPmhLqhpazdx5ubYbDfXXG6oMWd7tZBzpV+icE MvhiuIisi0RuwNZsvTouVeuUxuP5ukQBT7visTJyooRNLl0hfHtgQvYdbDyRoBP2PsKC 2drBNNL3Z3bSaD/aaehuwjZcCxko1Ts/vFeN0XLg2RryK5EfhAUf4CvcOTRgF08cek8H rVTZsgC7X127dPW9CpJKghVaF9pjXI9d/oXv9duHOSjJanbxb+ypKah41blHA7OWhsD3 DE5w== X-Gm-Message-State: APjAAAWBt1TL7YDI9ZRPwpNQgnfFeCmYqCZmu5TAQAZ3HtBJMwYvkwou nxXSlaqduzgXWbqtdlV+7CL/sHPReVA= X-Google-Smtp-Source: APXvYqxYVdj+f5aFVdRZ6TnkuzCYszYO1wWVmtmL+s9q/J/sFnxY0e08etpTuZCUkv9y/OyrZeDB0A== X-Received: by 2002:adf:fa0d:: with SMTP id m13mr16777626wrr.93.1551806515148; Tue, 05 Mar 2019 09:21:55 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:37 +0000 Message-Id: <20190305172139.32662-11-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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::443 Subject: [Qemu-devel] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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.) Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-11-peter.maydell@linaro.org Reviewed-by: Richard Henderson --- Makefile | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/Makefile b/Makefile index add22cf2947..0f5fdc2d2b2 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 -d .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 May 2 11:24:45 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 1551807606807656.6318485532374; Tue, 5 Mar 2019 09:40:06 -0800 (PST) Received: from localhost ([127.0.0.1]:46741 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1E2t-00083e-RH for importer@patchew.org; Tue, 05 Mar 2019 12:40:03 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35697) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlP-0002Kx-JU for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:22:00 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlO-0001KO-Nh for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:59 -0500 Received: from mail-wr1-x42c.google.com ([2a00:1450:4864:20::42c]:39093) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlO-0001Gk-GZ for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:58 -0500 Received: by mail-wr1-x42c.google.com with SMTP id l5so10353399wrw.6 for ; Tue, 05 Mar 2019 09:21:58 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.55 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:56 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=ZOZTZ5+1lHRBHfARGq8GqX/LlU3VKuLBCfBjT8nwCCU=; b=Fi2ohhzShoafwPraOJZLkBEbdAVXLiEJGGr1nCbiFIbNb7GKokSDMVt2NNrU2sMMMS 9USuUuml+tuCNkX/C8i86S+kllQ8Zl/MrV1a3M6nxkqKqlBwwSV/Hi1qrEkkyxtzXNLH 0twKBN63Lybfm+/sapkRbU7uXaijE+zG6cIXehl8UJoJx4nHaS6BTQ8XfKUKpA+/Fkgc 094E43Lx96SuY6HmIunI9NBEgwI+XGCcKFaykjZUVj/UDmpouFly1pMsNuYLGZFOfBfu lvf4Caglyp9nKpuboP9ApQtEF5uiEz35/3TilUiDG9f3J2zHtO4Xb3L7GAegt1E7NXcO W1tQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=ZOZTZ5+1lHRBHfARGq8GqX/LlU3VKuLBCfBjT8nwCCU=; b=ZOkbvf3ugFNNcinaS1ye1j8gs9vrG++SHKpjuJS47iP/MUcTOBYC252ScmzyTnj8jm 5pa7TCVKmH9v+ihptBokBbNWEN/gOSggI0mJB3g+uaKrYtD1zyDyg2PP67hzjjaWIoUi aAP9L3ixu36NA7Ewi8PHeff+b0a8D5seyko7Qo/58YQOzWm7zCMuqpNKUrildf/9sEN/ G8BfDjp7VEw+Tq5wPGsMmsvEzZZL1bH3RPx+Twt6WnQ68ZIVWEOFDz3GO4TvjJXnPgKC xwtolVo5cVy8mz5baTziSsZT33/qkBwmlDMUdeSTblD6YAalZQaYdSysWVEcu3OymMf/ ETNQ== X-Gm-Message-State: APjAAAVFbeYUPf9PbuEezcv8pb4jEY1v8U7y1REJ0UMchxaXGRGexZ+/ shJIkpfCqoHipFLFvmy27hoWTs8T2lk= X-Google-Smtp-Source: APXvYqzHm5qf3rnJfIJe3Nd1u7EYdwWQTddBUmAklMNfLQvShu2hcywDjh/vpHCSCylp05FbBqS/qg== X-Received: by 2002:adf:ee0f:: with SMTP id y15mr16640040wrn.197.1551806517374; Tue, 05 Mar 2019 09:21:57 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:38 +0000 Message-Id: <20190305172139.32662-12-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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::42c Subject: [Qemu-devel] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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 Message-id: 20190228145624.24885-12-peter.maydell@linaro.org Reviewed-by: Richard Henderson --- Makefile | 2 +- docs/conf.py | 21 ++++++++++++++++----- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 0f5fdc2d2b2..6b3732d114f 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 May 2 11:24:45 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 1551807711212371.4950882921912; Tue, 5 Mar 2019 09:41:51 -0800 (PST) Received: from localhost ([127.0.0.1]:46795 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1E4Y-0000v0-9K for importer@patchew.org; Tue, 05 Mar 2019 12:41:46 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35714) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlQ-0002MI-R4 for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:22:01 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlQ-0001Pv-34 for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:22:00 -0500 Received: from mail-wm1-x32c.google.com ([2a00:1450:4864:20::32c]:36690) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlP-0001Lj-S5 for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:22:00 -0500 Received: by mail-wm1-x32c.google.com with SMTP id j125so3381583wmj.1 for ; Tue, 05 Mar 2019 09:21:59 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.57 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:57 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=CWXu1AxNfjEkLWQepKJKxsGp1fFsuvUeDS3YHh1kTpM=; b=WPwuHHEDzR7/wOUxI5gILtW5qSAppKvqanEBsgJTznofsjUhsDokYzLj7/jy9NKSmy X0qiCzgepeV6iAOqmHDBgQsT9kiwFLcrCTVGHsgEnSnmKskeo8bd65pVmYb7rtgPH6Zi KSAPumXCuRm+hDIU0twBItsudpZUg4TSzpYI+xRAl4qBgUQgGKZIqbZTvQeuiVHFAqjI XnOKbvujQBigmE2UswvbM7shLVcLEMsRamjFQPgmfLRlqlzY/PxLm9zEXUaUcuOFAGos wbl+FKATOj0La5qgS5OeORDc5fXOYuHHcLDJ31uI1Ar16LnX9wUqMJBv4SbDSjUt+RU/ UseQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=CWXu1AxNfjEkLWQepKJKxsGp1fFsuvUeDS3YHh1kTpM=; b=AoFSJdpPSFoJlXo/8sB7YZaUvhZpsH+hXOszDn9O6p/bshB/F5pu3h9OuiquHsG3yU 5HBWgsrUPx6ULkygGvC38bd/mCXVACNH0tj0HhfI06BRXCTCnhH3P5uIeRzCo23XG+nv RdMPAsyYIytAkn3KQHr99WOJZoqTnIGg5XUL/aghlAMUzjIPU+DfAeu5HDqkwEM4HgvX 9yY7i+dAR2v5jC9alXWczHPYhW7NfYkRg4q4FW0D0u90QjOSWlV0E1xlYC/n//kESp4J cINx+IEbsgb1ZrMVm7CLEoRUkdE9cmdpXmtTWMG8iUKDDKAZluY1artVLZ+28IN8mi9o kmXQ== X-Gm-Message-State: APjAAAWOh4hyS/DgH6Z/S5PkKPwv35Rgyaxjy6yvM7qu6Bbn2acs2CzF 7bze8cqjIX0ScDSWD4EsDzd5j3c6/OE= X-Google-Smtp-Source: APXvYqza842pirpN0YLtj/kYtS+dmavlR7XvyGNN+xZJyftLzoMN/trPc2jji6JlfYQF3Em2oM1muw== X-Received: by 2002:a1c:7519:: with SMTP id o25mr3360157wmc.24.1551806518515; Tue, 05 Mar 2019 09:21:58 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:39 +0000 Message-Id: <20190305172139.32662-13-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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::32c Subject: [Qemu-devel] [PATCH v3 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: , Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aleksandar Markovic 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" 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 --- 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