From patchwork Thu Oct 3 20:56:20 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Cooper X-Patchwork-Id: 11173357 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id DA2B31709 for ; Thu, 3 Oct 2019 20:57:56 +0000 (UTC) Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id B50D12086A for ; Thu, 3 Oct 2019 20:57:56 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=citrix.com header.i=@citrix.com header.b="hLZhEb5F" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org B50D12086A Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=citrix.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1iG89S-00050c-IH; Thu, 03 Oct 2019 20:56:42 +0000 Received: from us1-rack-iad1.inumbo.com ([172.99.69.81]) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1iG89Q-00050K-Os for xen-devel@lists.xenproject.org; Thu, 03 Oct 2019 20:56:40 +0000 X-Inumbo-ID: 47c5a77c-e620-11e9-8c93-bc764e2007e4 Received: from esa4.hc3370-68.iphmx.com (unknown [216.71.155.144]) by us1-rack-iad1.inumbo.com (Halon) with ESMTPS id 47c5a77c-e620-11e9-8c93-bc764e2007e4; Thu, 03 Oct 2019 20:56:33 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=citrix.com; s=securemail; t=1570136193; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=30OKogFyaLUoOPEbKKzM8p6/WDDwpWl9n95tKfgISxM=; b=hLZhEb5Fahc+l0ynNzwFdzSc7iDC3xbicfofSkKcNPMT+Kr8+D5juSWD N4D1MhiMaff88RXCV8rPq7O2bSrtnh28zEyWK+KgHF6YE+gD29sq/wu9X IcTRlkeReqxphycGrUVdz3jBWEdqX5uP1Wqgv+64L/F39bJG3fcah52Kg o=; Authentication-Results: esa4.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none; spf=None smtp.pra=andrew.cooper3@citrix.com; spf=Pass smtp.mailfrom=Andrew.Cooper3@citrix.com; spf=None smtp.helo=postmaster@mail.citrix.com Received-SPF: None (esa4.hc3370-68.iphmx.com: no sender authenticity information available from domain of andrew.cooper3@citrix.com) identity=pra; client-ip=162.221.158.21; receiver=esa4.hc3370-68.iphmx.com; envelope-from="Andrew.Cooper3@citrix.com"; x-sender="andrew.cooper3@citrix.com"; x-conformance=sidf_compatible Received-SPF: Pass (esa4.hc3370-68.iphmx.com: domain of Andrew.Cooper3@citrix.com designates 162.221.158.21 as permitted sender) identity=mailfrom; client-ip=162.221.158.21; receiver=esa4.hc3370-68.iphmx.com; envelope-from="Andrew.Cooper3@citrix.com"; x-sender="Andrew.Cooper3@citrix.com"; x-conformance=sidf_compatible; x-record-type="v=spf1"; x-record-text="v=spf1 ip4:209.167.231.154 ip4:178.63.86.133 ip4:195.66.111.40/30 ip4:85.115.9.32/28 ip4:199.102.83.4 ip4:192.28.146.160 ip4:192.28.146.107 ip4:216.52.6.88 ip4:216.52.6.188 ip4:162.221.158.21 ip4:162.221.156.83 ~all" Received-SPF: None (esa4.hc3370-68.iphmx.com: no sender authenticity information available from domain of postmaster@mail.citrix.com) identity=helo; client-ip=162.221.158.21; receiver=esa4.hc3370-68.iphmx.com; envelope-from="Andrew.Cooper3@citrix.com"; x-sender="postmaster@mail.citrix.com"; x-conformance=sidf_compatible IronPort-SDR: XdZqhFxNrTVzcQbuQORjfZmViqm8fy2LksKI+K/Wz3gqlSEEEJQUGBswrej7/BgRoXfrB1VszA YII6f6ipM1U30bnDBsd19fJ8eZ/Zr9DgJm/2Bne7uf2bO6vHdCn9U9xOMCCQNbEFYkX7CktLZF 4mnfng+Sxn4DxIO9gOjonDLzoxpPMybnb1rQLGs0rpwcnJWyl7jTHbYAFY7PVOV4v2oR6pj201 vaZ+ljc9WFgQrEYBv/2liwXsqKsn3tNsMC732HQnh/fl80u2NI/jkr0xOtzlepugOaybwyUgjj xCI= X-SBRS: 2.7 X-MesageID: 6810846 X-Ironport-Server: esa4.hc3370-68.iphmx.com X-Remote-IP: 162.221.158.21 X-Policy: $RELAYED X-IronPort-AV: E=Sophos;i="5.67,253,1566878400"; d="scan'208";a="6810846" From: Andrew Cooper To: Xen-devel Date: Thu, 3 Oct 2019 21:56:20 +0100 Message-ID: <20191003205623.20839-1-andrew.cooper3@citrix.com> X-Mailer: git-send-email 2.11.0 MIME-Version: 1.0 Subject: [Xen-devel] [PATCH for-4.13 0/4] docs/sphinx X-BeenThere: xen-devel@lists.xenproject.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Cc: Juergen Gross , Lars Kurth , Stefano Stabellini , Julien Grall , Wei Liu , Konrad Rzeszutek Wilk , George Dunlap , Andrew Cooper , Tim Deegan , Rich Persaud , Jan Beulich , Ian Jackson , =?utf-8?q?Roger_Pau_Monn=C3=A9?= Errors-To: xen-devel-bounces@lists.xenproject.org Sender: "Xen-devel" Various pieces of Sphinx documentation improvements intended for inclusion into Xen 4.13. Rendered results can be viewed at https://andrewcoop-xen.readthedocs.io/en/docs-devel/index.html with https://andrewcoop-xen.readthedocs.io/en/docs-devel/admin-guide/introduction.html https://andrewcoop-xen.readthedocs.io/en/docs-devel/glossary.html https://andrewcoop-xen.readthedocs.io/en/docs-devel/misc/tech-debt.html being the notable additions from this series. Andrew Cooper (4): docs/sphinx: License content with CC-BY-4.0 docs/sphinx: Indent cleanup docs/sphinx: Introduction docs/sphinx: Technical Debt COPYING | 3 + docs/README.source | 32 ++++++++ docs/admin-guide/index.rst | 5 +- docs/admin-guide/introduction.rst | 40 ++++++++++ docs/admin-guide/microcode-loading.rst | 2 + docs/admin-guide/xen-overview.drawio.svg | 97 +++++++++++++++++++++++ docs/conf.py | 12 ++- docs/glossary.rst | 52 +++++++++++++ docs/guest-guide/index.rst | 6 +- docs/guest-guide/x86/hypercall-abi.rst | 52 +++++++------ docs/guest-guide/x86/index.rst | 6 +- docs/hypervisor-guide/code-coverage.rst | 6 +- docs/hypervisor-guide/index.rst | 6 +- docs/index.rst | 38 +++++++-- docs/misc/tech-debt.rst | 130 +++++++++++++++++++++++++++++++ 15 files changed, 444 insertions(+), 43 deletions(-) create mode 100644 docs/README.source create mode 100644 docs/admin-guide/introduction.rst create mode 100644 docs/admin-guide/xen-overview.drawio.svg create mode 100644 docs/glossary.rst create mode 100644 docs/misc/tech-debt.rst