From patchwork Tue Mar 5 17:21:28 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159698 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5220744jad; Tue, 5 Mar 2019 09:24:49 -0800 (PST) X-Google-Smtp-Source: APXvYqytxEPJ+02jadgAQ0mkGAofZZMZcCRQdbvypw9FdfmmdfcDon7zirSXK3w2VpbIY0Jm9E+0 X-Received: by 2002:a81:7dd5:: with SMTP id y204mr1909113ywc.251.1551806689731; Tue, 05 Mar 2019 09:24:49 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551806689; cv=none; d=google.com; s=arc-20160816; b=BPtzq7u2kUYA1SzEGZz07m1FDPtmvGrB2VF6X72KsOerNhhxHcvgKY74mnIEcBS9O+ s8EiajUT990ZE5yKgKJJZE5zNcSNKSRRZSbmhQFBoSr4bvrS6BvHIcx0KOcwfaIpWOf1 nv5pa+q7ia93nyvpw2U6dCkICc4rdK2W4Ax2+VWZtCoDsaL4PVgN65nAY/NFZKLcGFJY yo2aPBNhUmgSu//rq9cRpjcUbKbLLdkV6lcIlWgxFau7O+8d51hjf1JbQu+DNMrxlzqa Kc6mlNJu+4ZShD/SspwInnuPbUIw9DB3Vs8QaOHUUl/e8Lazz9AOplUrDn0fauSHqWCG HB6A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=G9EFylNXe34RQZQSo/UwiJzoZ9HtkVUMgBIkYDaPROs=; b=AGpARBS+F5G2AQ1LrN8YRHL8qnTWZXaOYg8CdyTu3HDzhjveVOwCcQ1v1qX3pUSaWG /OYDBu1d/9020hptdG6Vft/BYLBDcfXc4LFo/mdlDmswv+Leqdi0e/WDAkOiHGsTDBHS 7aQhF1LnPSvW+0N7eBnQ91Q60qDgbS5wDr+FBfMB9fmT+4PczrGN8xFfWwnzoioJBXlV QrzxUiQjMc5NarCkd6UIPVvXRxD7ASFi8OiEiqqyec6DXTyrzqeyN1RMqsjUvk66tMSF abTjdGkJn1nSQUaCMALAEatB+VxfH4576t+/KwYX8V8AzXLfhJSsEGZ/gm0KC9wZpLmp 2I4Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=wAIZhQOR; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id q133si5274143ywg.80.2019.03.05.09.24.49 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:24:49 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=wAIZhQOR; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46436 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Do9-0003On-3l for patch@linaro.org; Tue, 05 Mar 2019 12:24:49 -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) 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-Received: by 2002:a1c:cc0c:: with SMTP id h12mr3736726wmb.140.1551806503408; Tue, 05 Mar 2019 09:21:43 -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) 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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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; unexpected unindent. docs/cpu-hotplug.rst:75: WARNING: Block quote ends without a blank line; unexpected unindent. docs/cpu-hotplug.rst:76: SEVERE: Unexpected section title. } { docs/cpu-hotplug.rst:78: WARNING: Block quote ends without a blank line; unexpected 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ée Reviewed-by: Philippe Mathieu-Daudé Tested-by: Philippe Mathieu-Daudé Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-2-peter.maydell@linaro.org --- docs/cpu-hotplug.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) -- 2.20.1 Reviewed-by: Richard Henderson Reviewed-by: Cleber Rosa 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``:: (QEMU) device_add id=cpu-2 driver=IvyBridge-IBRS-x86_64-cpu socket-id=1 core-id=0 thread-id=0 { From patchwork Tue Mar 5 17:21:29 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159699 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5222267jad; Tue, 5 Mar 2019 09:26:05 -0800 (PST) X-Google-Smtp-Source: APXvYqxNYnv8BtBPBsikFRlednO15poo15yQWDzXjU19gZmQjgx4JPEFcrOXSWb7QYKNyuE+4dw7 X-Received: by 2002:a25:44d:: with SMTP id 74mr3131884ybe.222.1551806765724; Tue, 05 Mar 2019 09:26:05 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551806765; cv=none; d=google.com; s=arc-20160816; b=RNYvjAhRtiuPvxjtczGOJUQtF7l2uU+r29kYM/KWxzggiggwcOPzCUX6amjuIfoZUE YGCUBns8LScyioolJbnh8b9IwtO5PPw+BQ0RNXUgMXvm1iZSsGfOB6+eIfrHjjLhw38j NTl6y1tiY/yMlgDWJmTGpPV7DK9BAFDQPGhxNNV/QieJ5TlYFkAdJN6ZthkyRkXEEYuN QsRu/TzfqlAsFAg2a4YbqCAe/aH+uLgEcozXx9ZUxQhkqpfhOsE+7d0w/wYtHKyC5JXp UFGHPqwJHt/beufFGIEPVYqsW8nYV3lcu+CuAUNObc/3wOpuD1QyVSJy330ffPuh++4N 8Svw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=wpBH3UVWa5xs78E58hfC7XY52d6PFrvdK5V9hk6kivY=; b=VHViMIUxTLteul2/PyZuFA1JW460FUQPzVQoanK9YfuRuE7baVZbSNX/syBFc/hYk1 EgcCS21brq0ZUQUviMuaSqldmw9yTKIBecC/i/0v1/yY2Ll5fFajQFjRbYnwUaR+0oFv St3e5V9ZsAUqnFDl4xLb2iA6ce2dAPmFCWFUMpyjqtKHAPEC40QXL3GNZIiptsCaib3N G9MypeDMbdyu9//w6WoNUDVtjn5P+kQ14JIdimDk2jw1iTgzVcYqnC3vfzlJUWP6MIaV VrlIlEzBCP4zn9dyEwPrYt3GoR3EjUmDKMxefRxPMkHZa/A4acnmfQ8n7bd13AYqtEHp t55A== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=SP86LY0V; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id v185si5407921ywv.45.2019.03.05.09.26.05 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:26:05 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=SP86LY0V; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46510 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DpN-0005Wb-6b for patch@linaro.org; Tue, 05 Mar 2019 12:26:05 -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) 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-Received: by 2002:a05:6000:1084:: with SMTP id y4mr2292wrw.14.1551806504775; 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.43 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); 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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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ée Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-3-peter.maydell@linaro.org --- docs/devel/{memory.txt => memory.rst} | 128 ++++++++++++++------------ 1 file changed, 70 insertions(+), 58 deletions(-) rename docs/devel/{memory.txt => memory.rst} (85%) -- 2.20.1 Reviewed-by: Richard Henderson Reviewed-by: Cleber Rosa 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 @@ +============== The memory API ============== The memory API models the memory and I/O buses and controllers of a QEMU machine. It attempts to allow modelling of: - - 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 The memory model provides support for - - 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 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() 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. 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 0x8000 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:: 0 1000 2000 3000 4000 5000 6000 7000 8000 |------|------|------|------|------|------|------|------| @@ -228,8 +234,9 @@ offset 0x2000. As a diagram: D: [DDDDD] E: [EEEEE] -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] 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. 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] Priority values are local to a container, because the priorities of two regions are only compared when they are both children of the same container. @@ -257,6 +265,7 @@ guest accesses an address: - 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, returning @@ -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. Otherwise 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 Example memory map ------------------ -system_memory: container@0-2^48-1 - | - +---- lomem: alias@0-0xdfffffff ---> #ram (0-0xdfffffff) - | - +---- himem: alias@0x100000000-0x11fffffff ---> #ram (0xe0000000-0xffffffff) - | - +---- vga-window: alias@0xa0000-0xbffff ---> #pci (0xa0000-0xbffff) - | (prio 1) - | - +---- pci-hole: alias@0xe0000000-0xffffffff ---> #pci (0xe0000000-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 + system_memory: container@0-2^48-1 + | + +---- lomem: alias@0-0xdfffffff ---> #ram (0-0xdfffffff) + | + +---- himem: alias@0x100000000-0x11fffffff ---> #ram (0xe0000000-0xffffffff) + | + +---- vga-window: alias@0xa0000-0xbffff ---> #pci (0xa0000-0xbffff) + | (prio 1) + | + +---- pci-hole: alias@0xe0000000-0xffffffff ---> #pci (0xe0000000-0xffffffff) -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 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 can use the In addition various constraints can be supplied to control how these callbacks are called: - - .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 = 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 = 1. +- .impl.unaligned specifies that the *implementation* supports unaligned + accesses; if false, unaligned accesses will be emulated by two aligned + accesses. From patchwork Tue Mar 5 17:21:30 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159701 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5224360jad; Tue, 5 Mar 2019 09:28:12 -0800 (PST) X-Google-Smtp-Source: APXvYqybiLBxZpnD3edDmZzZTmHQ2rt6iiCGcfnGh933+e6RuCrx6w97fRBVJjeYwBmfq+JODI7Z X-Received: by 2002:a25:8149:: with SMTP id j9mr3276607ybm.400.1551806892002; Tue, 05 Mar 2019 09:28:12 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551806891; cv=none; d=google.com; s=arc-20160816; b=mCTj4CK9wC9F+YsvHarN54K01TnbTomgGRHrojFYvpAKTeyO36TYVCVfPAiSVmslHs LGafP+Rl25FeuyTGXcDQZQfjfgkIGl37BHDJnTi9IkKldFFIPp0C46kYDbx3MxwvvPyz mH/g0D+JOxnprfhprcwyDNGnNurTV6LzlPNJK151SsD9HAGPvtOKfxGWsg84KH83GUe5 NrVGkBHo5JRebbGLwDz1k41QIdFTQFDcyFgq724AvudwG8Mp7Sho9wIVy6M8k4+g8URC d117Ub3xK0XTkDYuvMJtAn6UYejXDwxcozS3BLztF8UgKK0yfMwDSoCtARsRBnwsLgSZ 3ATQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=Hcmr58/vFQKeFxBv45zNtbUyT6GOSIfsDz+3Rdf8Xck=; b=oiR2lPyHK7qHHoTU1rumsGiUAFVwjPPZUXFqTGUxtjoR956PxqCDz8jfnwsujFnwsj w1Si4WT4fzTByNzHuHkG2q4pI+EqdNKTUu0wqhFZ71pNwj/BHK0Ju109Je9kDBdZVNoT MbIAOJob5B1jFqe1sQ9zXHfkyWNHwWzf3YnKgwBaCT12ZVxCO/D8zQfkOCpiWlyniTtG Ybn4Zh7tPHUFF9jPCZuxtUTsDuCLASjQfMIYNuShC7p2Ywo8Et/HiWd7Ih9ygT8fWiEr jqLnqVS3k1nvdeqDB+ccCASMIUW3+cAhen7xJ85eVq1hkef5riQILmDl6n6Qy5MzI4hB 0lqQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=p3THOfPn; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id w129si5857323ybg.411.2019.03.05.09.28.11 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:28:11 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=p3THOfPn; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46532 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DrP-0006dD-FT for patch@linaro.org; Tue, 05 Mar 2019 12:28:11 -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) 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-Received: by 2002:adf:fd46:: with SMTP id h6mr16781547wrs.170.1551806506205; 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.44 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:45 -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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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 --- 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 -- 2.20.1 Acked-by: Richard Henderson 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 directory, +# 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 = '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 = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'QEMU' +copyright = u'2019, The QEMU Project Developers' +author = 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 = u'4.0' +# The full version, including alpha/beta/rc tags. +release = 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 = 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 = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = 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 = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_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#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'QEMUdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # 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 = [ + (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 = [ + (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 = [ + (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 least + contain the root `toctree` directive. + +Welcome to QEMU's documentation! +================================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` From patchwork Tue Mar 5 17:21:31 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159700 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5222838jad; Tue, 5 Mar 2019 09:26:36 -0800 (PST) X-Google-Smtp-Source: APXvYqysPhTM/e+ckRRnBQSGQ05b6K78AMym2esvpW0kOSIYyTLcjNs0yQd0InrlYPMUZPaBtUmZ X-Received: by 2002:a0d:ec05:: with SMTP id v5mr1876176ywe.165.1551806796561; Tue, 05 Mar 2019 09:26:36 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551806796; cv=none; d=google.com; s=arc-20160816; b=gRFdMSx+H964Hz1W3ZKS2jIQ8aok9UMzl5mWsuuoDLZ5wwuZv2aHJ9Cl/VOBIOu7ez RdWbib/MElNQGK734tgZP+vr9uuiMDlxgJ58WeImFvlrgrlo1bUXCijeZWH252mF9rvb 0bRc64iJFFJ8+XJB5ZwzOqu09oMvf+xb8a3SD1tkP8Cb4Vx8Sw5aAPbGzVHJnuktTItq TqcbI4OvwiqXVa5AdUAhexKXu/Y7ke4VcY4zX1pMaY/lprKLPac1w2EC3x8EKtXtStTP vs7ayCVhteuRJoKx9ywrTW2aTrwNOtEjuG3jA6DumJgKiJBCafGVHMzNdfhWv/7kZ3hB a2xA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=oJaVF8BUp6ymfY8LQ5ejKFv+zG/bV2ot9FpO3HIaIog=; b=jOu5fbQA/61XpI+o42JVs1Qa1bqnKJR8Ox/RhwjTTYJ14qEvZqeq/wXw1A5wngrjPE b+D4i1mzqHUE7LRLsFHyfXwoBeDVVGUHGgDtSWHoja1P5Bn+lgSJAF4hrvjlPpb3wLzb WokGZxsOoqZcret8bNB9+/LwHIvxjqIhYD7DF/rtHMp9bZFE5G+WoFhAADHcrMJ4C3Rd faoq9r93fRaxwZXcZ3kQFZ3+rhR6BSrlPzrWunUvpg+foyHMl6Jz4OYkFfW5tHbCeq7p C/xiOfJjMp7ez8WHJJ83KUDnKvxeizx1/MqJOlF1s0+GWp88ixGDCILeFKzTHsutEMvJ btLw== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=APfphyy2; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id t185si5764173yba.139.2019.03.05.09.26.36 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:26:36 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=APfphyy2; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46528 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Dps-00063M-33 for patch@linaro.org; Tue, 05 Mar 2019 12:26:36 -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) 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-Received: by 2002:a5d:4605:: with SMTP id t5mr16788880wrq.311.1551806507464; 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.46 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:46 -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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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ée Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-5-peter.maydell@linaro.org --- docs/conf.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) -- 2.20.1 Reviewed-by: Richard Henderson 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 = 'alabaster' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_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 = ['_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. From patchwork Tue Mar 5 17:21:32 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159702 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5224816jad; Tue, 5 Mar 2019 09:28:39 -0800 (PST) X-Google-Smtp-Source: APXvYqz4zVbPou0FGdSgVp7cYfoLuGI6fmGLrKtq7F28Blqzt+KgEhi3Wbb5GI1/AyRyUCMPFBDg X-Received: by 2002:a81:240f:: with SMTP id k15mr1893518ywk.331.1551806919384; Tue, 05 Mar 2019 09:28:39 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551806919; cv=none; d=google.com; s=arc-20160816; b=ymvE64Sc2LXZJN1Z1xwKZDNSmfb4Ar2Qbi4+BLx+UOl28IP6no3p2wRzM9unqFVSke Tb/oyIBb8q3PCOVV+pTvnTchfHVGpsaaXA/g3qPtcKhL2ZdtMd6YVe8uiY2t4OeG2uFR +giy0xVyUWovirOiM3JQxP9WVBLShQsf6DLTIJA4pxYXzS0hIDc6v1HuYv3HU4+Vk+Hw 1+RWCLcvMHtOFi9s6fNC2a3k/0/XpuopwCIS0dQMY42V0tCWCUrSzxkn4Bb3yEcIPe00 snVkR0yUo6Q7fXoVf7R7DjyoraYKHPbj8ppRyY9HHzKVxpl1Jcs8cwadBRJNYCbG6lAt 6klg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=adjvDY4ZAfEy3ZZCwY3KFl2vWubKI5IVVVGcqYgy1ds=; b=wA1txiea/jbIn5J70q8zne37mIBJAe4B7/5hJolc2V7Tbc5P+1I1ATxZUgrQYKCFX0 i4rbCa306U3cvkTh/RjS/74a9WuHJNUGvXyv4vnvsYvulVG89OQBzCR22okQ8CcuMt33 LMSRC0h+VamSFVOlRGo+wWowEaCE/ADO4zjECDDYek1+fOuia3Im/ECzr23aJlbiLNU7 y+yGStT4hCSfaWTDQPVYfGHNCz/zona7x3SHomUbCfu5x2M72ju+CeS8fR/HfxiMwu2T HUh26ftDv1s/jhlh+AaDRAanVTiYG01ut2YWi20wNhnQMno37QCiRnjK/onm6zkMs0x5 EBOQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b="Il+z//wa"; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id e80si5070992ybb.157.2019.03.05.09.28.39 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:28:39 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b="Il+z//wa"; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46548 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Drp-0007dj-Jk for patch@linaro.org; Tue, 05 Mar 2019 12:28:37 -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) 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-Received: by 2002:a05:6000:10c9:: with SMTP id b9mr16718497wrx.281.1551806508812; 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.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); 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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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ée Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-6-peter.maydell@linaro.org --- docs/conf.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) -- 2.20.1 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 @@ # If your documentation needs a minimal Sphinx version, state it here. # -# needs_sphinx = '1.0' +# 1.3 is where the 'alabaster' theme was shipped with Sphinx. +needs_sphinx = '1.3' # 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 = 'alabaster' # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars html_sidebars = { '**': [ - 'relations.html', # needs 'show_related': True theme option to display + 'about.html', + 'navigation.html', 'searchbox.html', ] } From patchwork Tue Mar 5 17:21:33 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159703 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5227413jad; Tue, 5 Mar 2019 09:30:58 -0800 (PST) X-Google-Smtp-Source: APXvYqxFOd+z7QRumbvqGWTsiy2KkHw8mLFrOWiCE2Yq977veTDX5/i2lTUoCV5zeWN0mc0CzzIY X-Received: by 2002:a0d:e6c8:: with SMTP id p191mr1863466ywe.444.1551807058509; Tue, 05 Mar 2019 09:30:58 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551807058; cv=none; d=google.com; s=arc-20160816; b=YzaK8kGVpsbNw0NiXhAg8eGRHB5iSH1d5d9M2or4du0CcMSxCS4NC10oQjUhRKCkH3 wk2AopGCG6mkIjywjcH3HQJ4tklvdBVI+2GQyQf6xJrAtCKZwJ+m0pjG/EwiS3jX1g/0 XvuNVFZyAM62Jv4+Eun5s+ywBJnbWE7EzW+FA3wk1DAikW0PMJMuz840N3EDfLFTy1N+ 2Vk1w3OcPPneU7Iqg48zjCLXrFe6xuIo1gnzMY5LcPD3odG89AdgybbWfxOC5wK99xC5 Z23zF54xDB1m0weuvpQGCMNYZglDN3mqiwP6tmkNhGDXRStZ5U6hRXDWOmty/lVW/1XT TCDQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=/AzklaR2lW3oTO1kTo5ZJYuiAP+puMVrEbO6mtGy0oo=; b=rCaxorqjDYQnu4zGowjOMiYxevRfDqRwjWO9BMVf5nMfAyXkJ6GcjSUJzPvlubZylM KDqj6YUzjFAm/M7VzqE+XqjaJ/Z9jmLerGKlmn8JMUKAeX4uriDQnTEJttYzu870oYTW G2fGAnd6DwjcLue3j1OPQelvG9uZJhCrdfVpDmKV/8ED/k/j3CVXWH3gK2EmhhT1R7uR lPZYGLwgl1tpIhyve7S+/64EBH6+24gizYbTP1xPFsC3jaSvZhJpvzvAp4QrDOH8FjIg VrEltBkjUs4bGqnzlO6GAJk2N2t+YryAl5QhmcVIjE45Zyz0HcN1Ua/E55S3J5K7Q4Pv Z83Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=xYdVZ8FB; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id o200si5483907ywd.287.2019.03.05.09.30.58 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:30:58 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=xYdVZ8FB; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46612 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Du6-0001N8-1l for patch@linaro.org; Tue, 05 Mar 2019 12:30:58 -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) 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-Received: by 2002:a1c:a817:: with SMTP id r23mr3405118wme.110.1551806510090; 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.48 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:49 -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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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ée Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-7-peter.maydell@linaro.org --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) -- 2.20.1 Reviewed-by: Richard Henderson 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 = { ] } +# 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 = False # -- Options for HTMLHelp output ------------------------------------------ From patchwork Tue Mar 5 17:21:34 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159705 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5233492jad; Tue, 5 Mar 2019 09:35:59 -0800 (PST) X-Google-Smtp-Source: APXvYqy2Y7MOD/Q0ToOwxwAWGKVIUSBVblFL50ZntyyDicGTnOX5ETTLxFgEACvQP/oDTVcDWHhY X-Received: by 2002:a25:e016:: with SMTP id x22mr3066534ybg.297.1551807359588; Tue, 05 Mar 2019 09:35:59 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551807359; cv=none; d=google.com; s=arc-20160816; b=trjnbifIrKZOMRTAiFjEv6B2moeJ6sas3Hgk50hqIs3O91eEaHWPengg8j2/0C0w/4 4DaeSv23IHoMx0CNSAUTwM64bjvEwzrhYf2KzGF43kczdRcGmWKEfdyh3zeemgasti9p h14r8rDsETvmyeMVQJt9elX8fCAYV3Bage5xB9cWK/TnRxnxQHsVLVv1wvsIyi0y0V/x YDsUbTTkv5D9D3jZ5ayMq+o1M0u46HAFERf+PAWP4jSGFBgl9d2Oe5T6HaBWy6RlLoHr HHVAARNWh4IkoUpkvhba1i/U/vkSqCvEX3tkxsAH2jwCZDhKnLNG35citJvSOhQgsbOK kulg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=8ij8uYPMGzrIP/UveMA7OLc/n2gSSUxVwM5zQO0bB+I=; b=c4VcmMgyAIxRP3wkt1opiKtgI9c46BbyH5xMecn/7F1TCyxSx1Roeb6CWk6/3jOjN0 EIAF9HO5I8rlhfalwWoJNemhltayBigFptVytEutY3OS0HvEfM288e4JO8WSSLi8pUQi ZE9ZvsV+Uzwxmh9lOH25amlVLwXHZXgzPDd0HN9vgJ2WZ4XgIybmTZ5uBfIOq96KlkRC 0MvWkYiwPDjeTCgV6V+qcR8lnzzFW0eXlqDuEZrTGnNCYiKSdKG1kxlMv4sq8ptTH9MP cdFsd7IA0Wg9CQs/UlGEOUaYCYML3YZ5jHhY7ZzdeBgbZ3eIa8fTBsb1o6buHMrNnL8k 5zWw== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=itiWxSQt; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id d141si5846458ywb.143.2019.03.05.09.35.59 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:35:59 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=itiWxSQt; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46650 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Dyx-000436-2N for patch@linaro.org; Tue, 05 Mar 2019 12:35:59 -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) 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-Received: by 2002:a7b:c74b:: with SMTP id w11mr3360602wmk.79.1551806511405; 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.50 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:50 -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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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ée Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-8-peter.maydell@linaro.org --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) -- 2.20.1 Reviewed-by: Richard Henderson 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 = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False +# Sphinx defaults to warning about use of :option: for options not defined +# with "option::" in the document being processed. Turn that off. +suppress_warnings = ["ref.option"] # -- Options for HTML output ---------------------------------------------- From patchwork Tue Mar 5 17:21:35 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159704 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5231098jad; Tue, 5 Mar 2019 09:33:48 -0800 (PST) X-Google-Smtp-Source: APXvYqx5/+qgGGbHlcXe34kTio3Vui9YPCneZYlTPtKOGALpBCKwBOYRF2+BcXbb/50kTYiGw0DQ X-Received: by 2002:a81:489:: with SMTP id 131mr1887808ywe.504.1551807228197; Tue, 05 Mar 2019 09:33:48 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551807228; cv=none; d=google.com; s=arc-20160816; b=Q1QarCwRxtlbczm0Hj4ADhQ+y3OjEFNms5DGP5nwMi18CaxPccFMyhWw2n0LupHLih Yq59ouVEiD+i8ozNa6dEHCE/qcJjTAI1C6Fjs0PUG0UWfN7frU3kP1VX5FG2ysaVsQVk apqVerPmH+J2rWxMj7DtyO4am4QB22xAEVq5XHkZ7O4VZWIITI1DbyAn/qU0ylox+Xqj t4C8b8vKlWXQ+YkHQpvqXpmkJecbnzf37o9tQjDc+Z8fMKyRjzOWmppoh/OVSi4VGjbz kPwYKq1pNyY62D0e7Hoy6yZUHaYM+xf7Qz3qAmcNcYB2qc3GLWXJAaeCIkrrwzEh+835 EIwQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=01uFVxLCrTIEn1+vZ/yUlBMIWfpbKqcloDaOhKzxQNk=; b=LVxieoOvMAEXHujNzisNpWzvZ7wMo3TnElsLJMKAF7ErF6om7mivy9ZyyL3FcE45Sk LHUrWk4etqW0ePGapmUCJjgUf+PGDohzDvWO2OrPxE2bmvP6ZyBuuPyALn9xPLuizMLd GlYXwyOfuEs6fT737K4Mov3/kkWTTp5b/iAKOwLlytFQFwL8WIPIXj3CgIsCx+PvjoUz 0xXk9q2dLZNAg5DFnj1JYUPG18zf1HjwWFN5CyLSGbZlkMFFEKTSKkT8l/ciJXE0zHhY dJS2gFzBqHFr446UYTgk19i+43dtBPBnSXLHLpYKoOfnR+jOGhzAy/AtHRTQuR3dsdjj pItQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=TEgUxys1; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id v3si5469255ybc.35.2019.03.05.09.33.47 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:33:48 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=TEgUxys1; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46632 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Dwp-0002Zi-Ao for patch@linaro.org; Tue, 05 Mar 2019 12:33:47 -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) 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-Received: by 2002:a5d:6592:: with SMTP id q18mr16464766wru.230.1551806512564; 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.51 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:51 -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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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ée 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 -- 2.20.1 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. +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 tree. +try: + qemu_docdir +except NameError: + qemu_docdir = os.path.abspath(".") + # If extensions (or modules to document with autodoc) are in another directory, # 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")) # -- General configuration ------------------------------------------------ @@ -91,8 +114,10 @@ html_theme = 'alabaster' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -# -# html_theme_options = {} +# We initialize this to empty here, so the per-manual conf.py can just +# add individual key/value entries. +html_theme_options = { +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, 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 tweaks. +import sys +import os + +qemu_docdir = os.path.abspath("..") +parent_config = 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'] = 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 +====================== + +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: + interop/index + devel/index - -Indices and tables -================== - -* :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 tweaks. +import sys +import os + +qemu_docdir = os.path.abspath("..") +parent_config = 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'] = u'System Emulation Management and Interoperability 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 +=========================================================== + +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 + From patchwork Tue Mar 5 17:21:36 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159706 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5233944jad; Tue, 5 Mar 2019 09:36:28 -0800 (PST) X-Google-Smtp-Source: APXvYqySrESU1Wvf0XKnE1ViQIo0DLLaOQtc+B6njmrTpO8D/aBpW/PHbBYwi3CuFbOVNm3zYaDq X-Received: by 2002:a25:1955:: with SMTP id 82mr3123995ybz.76.1551807388941; Tue, 05 Mar 2019 09:36:28 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551807388; cv=none; d=google.com; s=arc-20160816; b=RmSyMiz9PUJ1+FciVMnHRpwVIzCXVo9EhGSJh6RcyGmcGY4vafpRZ9u1V+TlaUmHVb yvXtG72CLUC/gIaYqCBM0gyCtSJa5iWX0nFqyP99B0MVTMgVB8CaHvG5OQ2tllkUyz15 WnRtUlBHguzaUiC/KoyHmL6p6HjZ2+yKTr15tEVWGSp6aItFBa1gy51iI5aKF3ODgKPm /Soi1gGH+riIGO7gn+liCXxl/8vxFtSNpPEAwnNslpg0AzXEVEnYGyKHePD2CVzT/U2+ MuvqwV1E2PJy/rCXwRWkysMYAAnAxXO/uYUZOLITaYe6mk0vyrk/Ahlhhx4G6PJ69E7r +UOQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=fMSJc4tOcDf53LeHi1yp309x64WCbqGkZGxQnTj7TS8=; b=yWGJXNrAqlBQPg2hqQb96B+dRW1eFesQAkbyxvQkvX9+sS66x33HzQUuNQdoYMaA0i XzXrnr3WraCU9wN8JYTEqllnYKK+kzLF7GcLFcB8oo2VJ7hiNRStIQ4ufGBiSHvrguHM Gnv6uexEkwFjc8RvVR3OScD7CZ9kp3JBTLdESIqNslkPjtxVUNgO3xJ306hR8ojNbDQm 3ebzu3Z99pG2cI9ernI2fyLHeYCDVCXFxWlkfoy8aDjX50UXWaCiieHXSjuYT1LF7NEU +QS4R17mwE4I+RfEIVju6AMRu3tePs9Nqs8tW0BHraNiJd7fSB4v207YtynJcN5K8BKT 5vPg== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b="SlRcq5n/"; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id t185si5496588ybf.403.2019.03.05.09.36.28 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:36:28 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b="SlRcq5n/"; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46660 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DzQ-0004Lb-Be for patch@linaro.org; Tue, 05 Mar 2019 12:36:28 -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) 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-Received: by 2002:a7b:c929:: with SMTP id h9mr3445896wml.106.1551806513827; 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.52 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); 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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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é Tested-by: Philippe Mathieu-Daudé Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-10-peter.maydell@linaro.org --- configure | 15 +++++++++++++-- Makefile | 45 ++++++++++++++++++++++++++++++++++++++++++--- .gitignore | 1 + 3 files changed, 56 insertions(+), 5 deletions(-) -- 2.20.1 Reviewed-by: Richard Henderson diff --git a/configure b/configure index cefeb8fcce4..47bf617fcc5 100755 --- a/configure +++ b/configure @@ -4589,13 +4589,24 @@ if compile_prog "" "" ; then syncfs=yes fi +# 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" "$TMPDIR1/sphinx/out" >/dev/null 2>&1 +} + # Check if tools are available to build documentation. if test "$docs" != "no" ; then - if has makeinfo && has pod2man; then + if has makeinfo && has pod2man && has_sphinx_build; then docs=yes else if test "$docs" = "yes" ; then - feature_not_found "docs" "Install texinfo and Perl/perl-podlators" + feature_not_found "docs" "Install texinfo, Perl/perl-podlators and python-sphinx" fi docs=no fi diff --git a/Makefile b/Makefile index 2208bde4196..add22cf2947 100644 --- a/Makefile +++ b/Makefile @@ -388,7 +388,7 @@ dummy := $(call unnest-vars,, \ include $(SRC_PATH)/tests/Makefile.include -all: $(DOCS) $(TOOLS) $(HELPERS-y) recurse-all modules +all: $(DOCS) $(if $(BUILD_DOCS),sphinxdocs) $(TOOLS) $(HELPERS-y) recurse-all modules 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,%,$@)" +# 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 = +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= endif -install-doc: $(DOCS) +define install-manual = +for d in $$(cd docs && find $1 -type d); do $(INSTALL_DIR) "$(DESTDIR)$(qemu_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","$@") +# 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 = $(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 = $(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","$@") @@ -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 -html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html +html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html sphinxdocs info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-ref.info pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt 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.* From patchwork Tue Mar 5 17:21:37 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159707 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5234234jad; Tue, 5 Mar 2019 09:36:48 -0800 (PST) X-Google-Smtp-Source: APXvYqx1qIcX2yuE4uzJg8NP5+Ek/WBkfM+I4d2pcWRbtIaMC7oBJ7s9apDo8yNhMaLNJn4wfzFO X-Received: by 2002:a81:8441:: with SMTP id u62mr1931168ywf.10.1551807408470; Tue, 05 Mar 2019 09:36:48 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551807408; cv=none; d=google.com; s=arc-20160816; b=UWgkZQFdHyIQ8Aa0MBK8Fexr8t62AgYGjcHoEyXcUBMP7f2yhXCvED6hz15XcjhVoX qjJAGQXhr60RHb7YaYqVlURWl5vT1gPWuJ9jQyzqERQIx3NG7bbXkm2WRDpuop7sUVre 1eVYLkOhKaopoOrPW3ZCRqY6XxNAm2tCaMhZ224ZE8sp3YNotwh+QeMzd4+mTWCVSgMt EXF0a0Nn6aprlMtGC+HDJ7boLYs3WMc/+y/WduiSF7Qm1oMRZx1DwFsvc8g/HmFZd4w6 JNup5UXF/d71wWo0U/unBqpNmA+HjYNtlJlUtTFOn+CGc/9b8ulKcvkYDslOkh9eOwV+ j6jQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=Z84Z1uZ6193RzY2x7LIy2GcmEPEbxZgOCrzhwfmtHHU=; b=0JUOCEg3qM++8qPi8WS0tVHsOIkSg/CQgkj6tKTcpVvRr01vfJ9mBx+sFqGW8b8iVd l8DDFk9OlmjemS/Q7hMkSvWzvRFxbHYE96yg+JC5ckQVxuGMqZaCvElNkV2bG1eC5cGh /sUQOwVSZtlbruXnxdDLLdWIpabthmpgFNQRAOY+JjqP1mhGj5qrgwbDz6nJCQCxpQcV mqEC/4zGwd6hna1+BS07gaPUdJmB0N99X2cWHmlX3ubCM3cNhS1QWB1Q3mUlbO3R0JtL YdQZfItktY2tLODF97trDrRKnKmzAgMCgcJHOcrr31RFF9GyKMa4Fo7t/XSMuOqKq/Gx TM0A== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=S0VjJBvo; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id 131si5468960ybw.116.2019.03.05.09.36.48 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:36:48 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=S0VjJBvo; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46699 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1Dzj-0005V9-Tz for patch@linaro.org; Tue, 05 Mar 2019 12:36:47 -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) 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-Received: by 2002:adf:fa0d:: with SMTP id m13mr16777626wrr.93.1551806515148; 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.53 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:54 -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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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ée Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-11-peter.maydell@linaro.org --- Makefile | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) -- 2.20.1 Reviewed-by: Richard Henderson diff --git a/Makefile b/Makefile index add22cf2947..0f5fdc2d2b2 100644 --- a/Makefile +++ b/Makefile @@ -87,6 +87,20 @@ endif include $(SRC_PATH)/rules.mak +# Create QEMU_PKGVERSION and FULL_VERSION strings +# If PKGVERSION is set, use that; otherwise get version and -dirty status from git +QEMU_PKGVERSION := $(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 := $(if $(QEMU_PKGVERSION),$(VERSION) ($(QEMU_PKGVERSION)),$(VERSION)) + GENERATED_FILES = qemu-version.h config-host.h qemu-options.def GENERATED_QAPI_FILES = 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 qemu-version.h: FORCE $(call quiet-command, \ - (cd $(SRC_PATH); \ - if test -n "$(PKGVERSION)"; then \ - pkgvers="$(PKGVERSION)"; \ - else \ - if test -d .git; then \ - pkgvers=$$(git describe --match 'v*' 2>/dev/null | tr -d '\n');\ - if ! git diff-index --quiet HEAD &>/dev/null; then \ - pkgvers="$${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 $@; \ From patchwork Tue Mar 5 17:21:38 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159708 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5236717jad; Tue, 5 Mar 2019 09:39:05 -0800 (PST) X-Google-Smtp-Source: APXvYqwoac1KqHuh593PtXmppk34o1SxaVCyEi2UBfCiu1sI4BqJ8KF5b8JYPq1wT0mzi+CMZ4uF X-Received: by 2002:a25:c804:: with SMTP id y4mr3222501ybf.429.1551807545800; Tue, 05 Mar 2019 09:39:05 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551807545; cv=none; d=google.com; s=arc-20160816; b=JSryIyPDERzi+O9gYG+bugscrlIrJFqeTJYLhQ4Keu07weMnr9955TYKBMbhT6wq+t AyCK6Ox60KbMGBiPS/bFZz3ro2MsIZnApsNF5Px62SMy3z9FE2i+vgGgibIMvYjZgcm4 cEWizOkY1kVrUlBIkq5c2L1jCYlDaAJZgHPEtlYCtNYEpvLmnfj/RR1Yxjyfo8/PgMK/ 0oB2hLWhzEVa2o6MVshF5pOe6DwzPkSgCYs9bwYJumRTZyAk96lQdaSBWmjxNMYr4BQ4 HH2cclmBqdMKrSsN8WmfKUBORUNDoGeDrAq5fo3skqRO6BXOwD8lxQ8BJLgHO1N7EviX Z2Fw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=ZOZTZ5+1lHRBHfARGq8GqX/LlU3VKuLBCfBjT8nwCCU=; b=GwM2VfRuAxLeHQOPx5VGsogrTKSK+VbU5fsGMUAc/hPhwj1fVoKzBlN3EPvEIK0DO+ 6hPif/2IEtIQyWpIE4vgDkMMTayTH7+Ez3lsnkSegV05IMYhNS3cTv/sCBeLo/5lqmD2 dN75ANOe47u2rUO4GTyvgfCA6iXV8lM0wnM9NegC2TNk8MoEdh4PZyDYlGi5UmdHCDwC 8tmMJ+kXzBJl7c+vDyN+NCt2TRKAjdx1ZMzA4L9ZL5bNXOBVe4W3M+maqupOYm26uTBP WZ70H/n9Idxs3sEVJ0v+SV6jUSvXko92xVYAldewYC6ANa4PS8zROabusxDPoBoKuOl8 7/ng== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=Fi2ohhzS; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id b132si5704644yba.373.2019.03.05.09.39.05 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:39:05 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=Fi2ohhzS; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46724 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1E1x-0007N1-BW for patch@linaro.org; Tue, 05 Mar 2019 12:39:05 -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) 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-Received: by 2002:adf:ee0f:: with SMTP id y15mr16640040wrn.197.1551806517374; Tue, 05 Mar 2019 09:21:57 -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) 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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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ée Reviewed-by: Philippe Mathieu-Daudé Tested-by: Philippe Mathieu-Daudé Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-12-peter.maydell@linaro.org --- Makefile | 2 +- docs/conf.py | 21 ++++++++++++++++----- 2 files changed, 17 insertions(+), 6 deletions(-) -- 2.20.1 Reviewed-by: Richard Henderson 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 # Canned command to build a single manual -build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -b html -d .doctrees/$1 $(SRC_PATH)/docs/$1 docs/$1 ,"SPHINX","docs/$1") +build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -b html -D version=$(VERSION) -D release="$(FULL_VERSION)" -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 = $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py 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 = 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 = u'4.0' -# The full version, including alpha/beta/rc tags. -release = 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 = None + with open(os.path.join(qemu_docdir, '../VERSION')) as f: + extracted_version = f.readline().strip() +except: + pass +finally: + if extracted_version: + version = release = extracted_version + else: + version = release = "unknown version" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. From patchwork Tue Mar 5 17:21:39 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159709 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5238614jad; Tue, 5 Mar 2019 09:40:51 -0800 (PST) X-Google-Smtp-Source: APXvYqxpJM5MHcLKgOcH61MZXgrsvkE5THmgOObsa46Ee3NJiC2CL5NJyuLArQ4re0mZwNlknKQM X-Received: by 2002:a25:1444:: with SMTP id 65mr3083464ybu.22.1551807651476; Tue, 05 Mar 2019 09:40:51 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551807651; cv=none; d=google.com; s=arc-20160816; b=jkmPDzNYE6ZYV3kaiwlL16RKE1dLEbXLvUO0y5rIfIpYNiPJm0bm6xt71vuB0AivSc At4oo7EK5olQkr7Jm54u2Xk5WrfFebPQm7olvEgHlWHcedsN+3spRAtO64xWwYFXXHix rsw1ydRxlCSZ5Jy8HTCwMI5qqW7vHn0C6IpUpHGPjIxfktu+6dbINZgAqEOTRSyyGyMm kxf4Z72BMiZKHJMG7arLFOSOnBMaU1iSgqN2YKSFQ6V4f2tEpuB8rY1eXxlTdrn+b8Bj 4bLY/dHyheK68j+wb+NO6Tvx0e0A/hJyIj/SD4ZgnO8VaqisTXXd16v9j3hkos8NN3rc reiA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=CWXu1AxNfjEkLWQepKJKxsGp1fFsuvUeDS3YHh1kTpM=; b=fRJ8n8xmyeJ5HJ9wfItRduzMIT5uWAXksn2av9QqX//dKfzSjICTu2dxbPMNs4Ggfu TsnUw3NeEfqBfdcOW7uZeWcK5dv7XtxjlBf57lcOooqEF6TGU2Qd66VrLvUDGG8UtqTh HvLi3GhUkm3VIztMuvltyi6NfcJr+9kCiBnFiwns+j8+rlPJwtreJEIMt+fd6qL33R4r 3KlQOEjcou5xUPgpeEAwNXiYwH0+fP2tgTDQ8kTBGmIbptPLA2yUrIbfbWZS6mLRNTDn 1VvTtGNqIKgYSHgxjIG2XjSvA2gfwLa8MwTaYeReZlkDTTSm7MKFuCNzCSVVAKd1FbAP iYRQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=WPwuHHED; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id x1si6075643ybf.441.2019.03.05.09.40.51 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:40:51 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=WPwuHHED; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46777 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1E3f-0000Kl-2w for patch@linaro.org; Tue, 05 Mar 2019 12:40:51 -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) 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-Received: by 2002:a1c:7519:: with SMTP id o25mr3360157wmc.24.1551806518515; 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.57 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:57 -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 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_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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 --- MAINTAINERS | 6 ++++++ 1 file changed, 6 insertions(+) -- 2.20.1 Reviewed-by: Philippe Mathieu-Daudé Reviewed-by: Richard Henderson 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