From nobody Tue May 21 16:17:02 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) client-ip=192.237.175.120; envelope-from=xen-devel-bounces@lists.xenproject.org; helo=lists.xenproject.org; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=pass(p=reject dis=none) header.from=citrix.com ARC-Seal: i=1; a=rsa-sha256; t=1699457292; cv=none; d=zohomail.com; s=zohoarc; b=ftcFkW7FC40hVmIoTJ5AOW0bJ+jgUSOamadeAs/GsLo7+AH0N7e7YsUmO5gHqGdXqWPnHA+IcK2yQkgfo90lj6YFZ1cyryFWPG5o1Lwb7kyst0pY4dWZ1Kz/Rf9ibIPoNvMfOSm+7CWq/D/HV9GuFj0MR2KTfy7iM/+fPTtgvlc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1699457292; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=faNUwfrZTENSIfZ6CUHj+O3RefTnBx+2DXknbOPrT9E=; b=l1aSPP44upemHgIelWG2BCVjI+zXZrKLuQPBfy4Mtf01iVUEnKeBbWvsVs1c9eiSptRQi0gL8wwMxVO92JyH1evUX2t37E9B4vH6nCIVGXvxqHID3vLE38K1sz7dCMuBWXlOMCa5ql7uTGGSysGMlgTj4QGY+5xhyi127QE9jB4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) by mx.zohomail.com with SMTPS id 1699457292476559.1787445239928; Wed, 8 Nov 2023 07:28:12 -0800 (PST) Received: from list by lists.xenproject.org with outflank-mailman.629317.981439 (Exim 4.92) (envelope-from ) id 1r0kT5-0001mo-PE; Wed, 08 Nov 2023 15:27:47 +0000 Received: by outflank-mailman (output) from mailman id 629317.981439; Wed, 08 Nov 2023 15:27:47 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r0kT5-0001mh-MS; Wed, 08 Nov 2023 15:27:47 +0000 Received: by outflank-mailman (input) for mailman id 629317; Wed, 08 Nov 2023 15:27:45 +0000 Received: from se1-gles-sth1-in.inumbo.com ([159.253.27.254] helo=se1-gles-sth1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r0kT3-0001ly-RU for xen-devel@lists.xenproject.org; Wed, 08 Nov 2023 15:27:45 +0000 Received: from esa4.hc3370-68.iphmx.com (esa4.hc3370-68.iphmx.com [216.71.155.144]) by se1-gles-sth1.inumbo.com (Halon) with ESMTPS id 5c0726d3-7e4b-11ee-98da-6d05b1d4d9a1; Wed, 08 Nov 2023 16:27:44 +0100 (CET) X-Outflank-Mailman: Message body and most headers restored to incoming version X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 5c0726d3-7e4b-11ee-98da-6d05b1d4d9a1 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=citrix.com; s=securemail; t=1699457264; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=4qvYJ95Qmj7vNymP0W4t0jy4zi1qzcW9Flfs/fZR3q8=; b=iQJel6izEMc7k9p8Bo8ISf+JVvjxzxXiLkN/HhgbrpLv9a31u9/Zdodj DfqdY+r949jeJm+HBwAdCHoOgT8Ew1r/IrT8bbzrzI/ql5IW3KE2mmMxK rfIqSTydTqz2pAgDiPYgjy2xSMHspYjg4fl0OiD5BuhIw9mhuSJQ2Kflp o=; X-CSE-ConnectionGUID: rtGzRFCOSGaJJVEY25MWVw== X-CSE-MsgGUID: qPYDbZIdQjeEc228BsiRDw== Authentication-Results: esa4.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none X-SBRS: 4.0 X-MesageID: 130706603 X-Ironport-Server: esa4.hc3370-68.iphmx.com X-Remote-IP: 162.221.159.70 X-Policy: $RELAYED X-ThreatScanner-Verdict: Negative IronPort-Data: A9a23:QpM02643ssFRzzl6B0WWTgxRtMfHchMFZxGqfqrLsTDasY5as4F+v jZKUTuPPa7eZWLzfYt/Poi29UxSvZGDnNVqTgNori1mHi5G8cbLO4+Ufxz6V8+wwm8vb2o8t plDNYOQRCwQZiWBzvt4GuG59RGQ7YnRG/ykTraCY3gtLeNdYH9JoQp5nOIkiZJfj9G8Agec0 fv/uMSaM1K+s9JOGjt8B5mr9lU355wehBtC5gZlPKkT7AeH/5UoJMl3yZ+ZfiOQrrZ8RoZWd 86bpJml82XQ+QsaC9/Nut4XpWVTH9Y+lSDX4pZnc/DKbipq/0Te4Y5iXBYoUm9Fii3hojxE4 I4lWapc6+seFvakdOw1C3G0GszlVEFM0OevzXOX6aR/w6BaGpdFLjoH4EweZOUlFuhL7W5m7 +A3OgojRTe4qOuU4oyWe7Mxo/sdM5y+VG8fkikIITDxCP8nRdbIQrnQ5M8e1zA17ixMNa+AP YxDM2MpNUmRJUIXUrsUIMtWcOOAr3/zaTBH7nmSorI6+TP7xw1tyrn9dtHSf7RmQO0MxR7H/ jyYpz+R7hcyLeSu5TC3036VhOLilnmhCKgJFYeU6as/6LGU7jNKU0BHPbehmtGph0j7V99BJ kg8/is1sbN05EGtVsP6XRCzvDiDpBF0c/h6HvA+6QqN4rHJ+AvfDW8BJhZac8AvvsIyQT0s1 3eKksnvCDgpt6eaIVqC8p+EoDX0PjIaRUcAeCsFQA0t89Tl5oYpgXrnRdZ5EbWpicX1FCu2y DSDtisWnKkal8oC3eO6+jjvjyq3o5nVTiY8/gjNQn++9QR9eZKkYIqzr1Pc6J5oDIufVEjHg 3EClOCX9uVIBpaI/BFhW81UQuvvvazcdmSB0BgwR/HN6ghB5Va5Ya9C2h9VA3xGO+QmRxLYO hL2hj1Osco70GSRUUNnX26gI510nPm8TIm9CqG8gslmOMYrKFHdlM16TQvAhzqzzRJEfbQXY M/DKa6R4WAm5bOLJdZcb8way7Yvjhsm32LVSouTI/+PiuHGOyf9pVvoKjKzggEFAECs+l69H y53bZfi9vmmeLSWjtPr2YASN0sWCnMwGIr7rcdaHsbafFs3QzF7U6+OnOl+E2CAo0iyvr6Xl kxRp2cBlQGh7ZE5AV7iho9fhEPHAs8k8CNT0d0ENle0wXkzCbtDH49GH6bbiYIPrbQ5pdYtF qltRil1KqgXItgx02hHPMaVQU0LXEjDuD9iyAL8OmdmIcc+GFGSkjImFyO2nBQz4uOMnZNWi 9WdOsnzG/LvmywK4B7qVc+S IronPort-HdrOrdr: A9a23:/7Th4Kish5tsMpDT1NSgRJPAZnBQX8d23DAbv31ZSRFFG/FwyP rDoB1L73LJYWgqMk3IwerwQZVoMkmsjaKdgLNhdItKOTOM11dAQ7sSiLcKrwePJ8S6zJ866U 4CSdk3NDSTNykfsS+S2mDRLz9j+qjhzEnBv5ab854Hd2FXgtRbnmVE43GgYy5LrWd9ZKYRJd 653I5qtjCgcXMYYoCSAWQEZfHKo5nmhY/rehkPAj8g8U2rgSmz4LD3PhCE1lNGOgk/i4sKwC zgqUjU96+ju/a0xlv10HLS1Y1fnJ/M28ZOH8uFj+kSM3HJhhyzbIpsdrWetHQeof2p6nwtjN 7Qyi1QdPhb2jf0RCWYsBHt0w7v3HIF8Hn502KVhnPlvIjQWC86I9Apv/MVTjLpr24b+P1s2q NC2GyU87BNCwnboSj779/UEzl3i0uPp2Y4m+J7tQ0SbWJeUs4fkWUsxjIVLH4yJlO71GnhKp gsMCjo3ocZTbpdVQGagoAg+q3oYp15JGb8fqFLgL3u79EepgEE86MVqfZv40so5dYzTYJJ6P /DNbktnLZSTtUOZaY4H+sZR9CrY1a9NS4kHVjiU2gPLpt3Tk7lutry+vE49euqcJsHwN87n4 nASkpRsSo3d1j1AcOD0ZVX+lSVKV/NKwjF24Vb/dx0q7f8TL3kPWmKT00vidKpp7EaDtfAU/ i+NZpKC7voLHfoG4xOwwriMqMiXkU2QYkQoJI2SliOqsXEJsnjsfHaau/aIP73HTMtSgrEcw g+tfjIVbV9B2yQKw7FaULqKgzQk2TEjOxNLJQ= X-Talos-CUID: 9a23:WVNEam8tKQf6y1QXAgyVv1QINdIfXFb691jZAW2GJFczFZiqd0DFrQ== X-Talos-MUID: 9a23:NAZt/gomQvvQj1OOvUcezyhaBeti0YWiMUIAvJ5c4ZmuLi1KFyjI2Q== X-IronPort-AV: E=Sophos;i="6.03,286,1694750400"; d="scan'208";a="130706603" From: Andrew Cooper To: Xen-devel CC: Andrew Cooper , George Dunlap , Jan Beulich , "Stefano Stabellini" , Wei Liu , Julien Grall , Christopher Clark , "Daniel P . Smith" , Henry Wang Subject: [PATCH for-4.18 1/3] docs/sphinx: Fix syntax issues in hyperlaunch.rst Date: Wed, 8 Nov 2023 15:27:25 +0000 Message-ID: <20231108152727.58764-2-andrew.cooper3@citrix.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20231108152727.58764-1-andrew.cooper3@citrix.com> References: <20231108152727.58764-1-andrew.cooper3@citrix.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @citrix.com) X-ZM-MESSAGEID: 1699457294587100003 sphinx-build reports: docs/designs/launch/hyperlaunch.rst:111: WARNING: Title underline too sho= rt. docs/designs/launch/hyperlaunch.rst:203: WARNING: Unexpected indentation. docs/designs/launch/hyperlaunch.rst:216: WARNING: Unexpected indentation. Nested lists require newlines as delimiters. Signed-off-by: Andrew Cooper Acked-by: Stefano Stabellini --- CC: George Dunlap CC: Jan Beulich CC: Stefano Stabellini CC: Wei Liu CC: Julien Grall CC: Christopher Clark CC: Daniel P. Smith CC: Henry Wang --- docs/designs/launch/hyperlaunch.rst | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/designs/launch/hyperlaunch.rst b/docs/designs/launch/hype= rlaunch.rst index 4c138da884cc..3bed36f97637 100644 --- a/docs/designs/launch/hyperlaunch.rst +++ b/docs/designs/launch/hyperlaunch.rst @@ -108,7 +108,7 @@ both modes of configuration from the same binary and wh= en paired with its XSM flask, provides strong controls that enable fine grained system partitioni= ng. =20 Hypervisor Launch Landscape ---------- +--------------------------- =20 This comparison table presents the distinctive capabilities of Hyperlaunch= with reference to existing launch configurations currently available in Xen and @@ -200,11 +200,13 @@ The benefits of this structure include: domains. * Commonality: Reuses the same logic for initial basic domain building acr= oss diverse Xen deployments. - * It aligns the x86 initial domain construction with the existing Arm - dom0less feature for construction of multiple domains at boot. - * The boot domain implementation may vary significantly with different - deployment use cases, whereas the hypervisor implementation is - common. + + * It aligns the x86 initial domain construction with the existing Arm + dom0less feature for construction of multiple domains at boot. + + * The boot domain implementation may vary significantly with different + deployment use cases, whereas the hypervisor implementation is common. + * Correctness: Increases confidence in the implementation of domain construction, since it is performed by the hypervisor in well maintained= and centrally tested logic. @@ -213,8 +215,9 @@ The benefits of this structure include: * Capability: Supports launch of advanced configurations where a sequenced start of multiple domains is required, or multiple domains are involved = in startup of the running system configuration - * eg. for PCI passthrough on systems where the toolstack runs in a - separate domain to the hardware management. + + * eg. for PCI passthrough on systems where the toolstack runs in a separ= ate + domain to the hardware management. =20 Please, see the =E2=80=98Hyperlaunch Device Tree=E2=80=99 design document,= which describes the configuration module that is provided to the hypervisor by the bootloader. --=20 2.30.2 From nobody Tue May 21 16:17:02 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) client-ip=192.237.175.120; envelope-from=xen-devel-bounces@lists.xenproject.org; helo=lists.xenproject.org; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=pass(p=reject dis=none) header.from=citrix.com ARC-Seal: i=1; a=rsa-sha256; t=1699457292; cv=none; d=zohomail.com; s=zohoarc; b=XC9ud0NTyQN46ERcC3KpCjB+AaV0JyFjtAqgxFN2bdps0Q2oR/0P31BjBorvfpiP59yTQqMzBzPGCG8wC5GJeD9M8twFGQfRjgD8qkktuPrY+6AQrY90cQCX+tU7AefDKQCyochvs5uMKHukzmestWMfrRNNpmmnthD6oMfQu1k= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1699457292; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=XWMRMDzzG3y5/dltq9my2XCfEC4H04ok+vM5JdG+tBk=; b=CweuayVmjOXuzQH0jRi6FToGS6bbjD3/1oKGt5kluFNn/IW8jYdnd77U//YindvgJ58gs6sG4Me4dcMy61u3/UDgXQWFn76eXbRyO36N3r1c+5hLkHjSUGXYOauBk4mvJRDLTHwz1XkD55kAv9mr/5flZpfwUOHQ2/VM+9ZUm24= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) by mx.zohomail.com with SMTPS id 1699457292163269.2697837684228; Wed, 8 Nov 2023 07:28:12 -0800 (PST) Received: from list by lists.xenproject.org with outflank-mailman.629319.981459 (Exim 4.92) (envelope-from ) id 1r0kT8-0002Hj-AY; Wed, 08 Nov 2023 15:27:50 +0000 Received: by outflank-mailman (output) from mailman id 629319.981459; Wed, 08 Nov 2023 15:27:50 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r0kT8-0002HY-5y; Wed, 08 Nov 2023 15:27:50 +0000 Received: by outflank-mailman (input) for mailman id 629319; Wed, 08 Nov 2023 15:27:49 +0000 Received: from se1-gles-sth1-in.inumbo.com ([159.253.27.254] helo=se1-gles-sth1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r0kT6-0001ly-Ug for xen-devel@lists.xenproject.org; Wed, 08 Nov 2023 15:27:48 +0000 Received: from esa6.hc3370-68.iphmx.com (esa6.hc3370-68.iphmx.com [216.71.155.175]) by se1-gles-sth1.inumbo.com (Halon) with ESMTPS id 5f24f926-7e4b-11ee-98da-6d05b1d4d9a1; Wed, 08 Nov 2023 16:27:48 +0100 (CET) X-Outflank-Mailman: Message body and most headers restored to incoming version X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 5f24f926-7e4b-11ee-98da-6d05b1d4d9a1 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=citrix.com; s=securemail; t=1699457268; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=7iglAxJ1pea3nVzftE4nEQ94KmXbS9vQNc+FWozJ1fM=; b=QryPlWhFEyCwmMwpQp1maqXmOPz1m6aZ1lAC+iWWq5faeo0B05OgjhIo pzhuxYfqagMYvg6kWT1Di4e6Une2yEfKGwr00Hk7h+GWt6bcSGk8xyoiI 1p7TfbQSwpHEYRPRUJvMOJGnZInXznZ8leksAWBR3mHgj3tZv5NOCCYEP 0=; X-CSE-ConnectionGUID: O7ec57rRToercaUqjXa8Kg== X-CSE-MsgGUID: 9bHeHTWHR0mgSc+U9LIEXQ== Authentication-Results: esa6.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none X-SBRS: 4.0 X-MesageID: 127132505 X-Ironport-Server: esa6.hc3370-68.iphmx.com X-Remote-IP: 162.221.159.70 X-Policy: $RELAYED X-ThreatScanner-Verdict: Negative IronPort-Data: A9a23:kFSvdKCehBEF9BVW//njw5YqxClBgxIJ4kV8jS/XYbTApDpw3mdVy TYaXWyHOPyMYTH1eIh/bYi08UJTsJKDz94yQQY4rX1jcSlH+JHPbTi7wuUcHAvJd5GeExg3h yk6QoOdRCzhZiaE/n9BCpC48D8kk/nOH+KgYAL9EngZbRd+Tys8gg5Ulec8g4p56fC0GArIs t7pyyHlEAbNNwVcbCRMsMpvlDs15K6p4WpA7gRnDRx2lAS2e0c9Xcp3yZ6ZdxMUcqEMdsamS uDKyq2O/2+x13/B3fv8z94X2mVTKlLjFVDmZkh+AsBOsTAbzsAG6Y4pNeJ0VKtio27hc+ada jl6ncfYpQ8BZsUgkQmGOvVSO3kW0aZuoNcrLZUj2CA6IoKvn3bEmp1T4E8K0YIw3bl6CjwR7 8YkLz0XZRm+nuCGyeKYRbw57igjBJGD0II3v3hhyXfSDOo8QICFSKLPjTNa9G5u3IYUR6+YP pdIL2U3BPjDS0Qn1lM/IZQyhuq3wFL4dCVVsgm9rqsr+WnDigd21dABNfKMIIPTHp8IxhvwS mTurm7ZDzEmC/ylkT+KyXnvu77rvA7LYddHfFG/3qEz2wDCroAJMzUGWF3+rfSnh0qWX9NEN 1dS6icotbI19kGgUp/6RRLQiFyuswMYWtFQO/Yn8wzLwa3Riy6CHXQNRDNFbN0gtec1SCYs2 1vPmMnmbRRwtJWFRHTb8a2bxRuwJCwUIGkqdSICCwwf7LHLpJw4h1TBR9BoHaqxk/X8AzS2y DePxAAeirMJnIg03qO01VndhnSnoZ2hc+IuzlyJBCT/tFo/PdP0IdPwgbTG0RpeBKHGQ1Lc4 2I+p8+T9usHMIiPpCXdY+pYSdlF+M253C3gbU9HRsdwpmj0pib/LOi88xkkeh01bJxslSvBJ R+L410Mvve/KVPzNfcvC79dHfjG2kQJ+T7NfffOZ94GWYBrdQmI50mCjmbLhDiyySDAfUwlU Kp3kPpA7l5AUsyLNBLsG48gPUYDn0jSP1/7S5Hh1AiA2rGDfnOTQrptGALQP7FivPnc8FqIq Yk32y62J/J3CbKWX8Uq2ddOdg5iwYYTXvgaVPC7hsbce1E7SQnN+tfawK87epwNokimvr6gw 51JYWcBkACXrSSeeW23hoVLNOuHsWBX8ShqYkTB/D+AhxAeXGpYxP5FKMJpJOd4qbcLIDwdZ 6BtRvhsy89nElzvkwnxp7GkxGC+XHxHXT6zAhc= IronPort-HdrOrdr: A9a23:WUTDb6yfMZu241kcLPcgKrPxMegkLtp133Aq2lEZdPULSKClfp GV8cjziyWftN9IYgBYpTnyAtj5fZq8z+893WB1B9zMYOCIghrMEGgP1+XfKnjbakvDH41mpO 9dmspFebnN5DFB5K7HCUuDYrEdKbG8geSVbIzlr0uFODsaCZ2ImD0JaTpzfHcWeCB2Qb4CUL aM7MtOoDStPVwRc8SAH3EAG8TTutHRk5riQBgeQzoq8hOHgz+E4KPzV0Hw5GZVbxp/hZMZtU TVmQ3w4auu99m91x/nzmfWq7hGhdf7zdNHJcqUzuwYMC/lhAqEbJloH5eCoDc2iuey70tCqq iGnz4Qe+BIr1/BdGC8phXgnyP61iw11nPkwViExVP+vM3QXlsBeod8rLMcViGcx1srvdl63q 4O9XmerYBrARTJmzm4z8TUVittilG/rRMZ4KIuZj1kIMQjgY1q3M0iFXBuYdc99eXBmcMa+d xVfY/hDTBtABGnhj7izyxSKZeXLw8O91+9MzI/U4WuokRrdHwV9Tpk+OUP2ngH754zUJ9C+q DNNblpjqhHSosMYbt6H/ppe7rCNoXhe2O/DIupGyWTKIgXf3bW75Ln6rQ84++nPJQO0ZspgZ zEFFdVr3Q7dU7iAdCHmMQjyGG6fEytGTD2js1O7ZlwvbPxALLtLC2YUVgr18+tue8WDMHXU+ u6fJhWH/jgJ23zHpsh5XyIZ7BCbX0FFMEFsNcyXFyD5srNN43xr+TeNO3eIbL8eAxUKV8Xwk FzLAQbCP8wn3xDAEWI/yQ5c0mdBHDCwQ== X-Talos-CUID: 9a23:RaCBO2zecgIcOofy5hP6BgUzRc0uLyLH9kvXLlWzAFtwSo2cGXyfrfY= X-Talos-MUID: 9a23:2cHz8wVF31nbc/Hq/G7mpDxCCPhI2fyrB3sG0qhXn+ipBRUlbg== X-IronPort-AV: E=Sophos;i="6.03,286,1694750400"; d="scan'208";a="127132505" From: Andrew Cooper To: Xen-devel CC: Andrew Cooper , George Dunlap , Jan Beulich , "Stefano Stabellini" , Wei Liu , Julien Grall , Luca Fancellu , Henry Wang Subject: [PATCH for-4.18 2/3] docs/sphinx: Fix syntax issues in exclude-list.rst Date: Wed, 8 Nov 2023 15:27:26 +0000 Message-ID: <20231108152727.58764-3-andrew.cooper3@citrix.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20231108152727.58764-1-andrew.cooper3@citrix.com> References: <20231108152727.58764-1-andrew.cooper3@citrix.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @citrix.com) X-ZM-MESSAGEID: 1699457292713100001 Content-Type: text/plain; charset="utf-8" sphinx-build reports: docs/misra/exclude-list.rst:47: WARNING: Unexpected indentation. docs/misra/exclude-list.rst:50: WARNING: Inline emphasis start-string wit= hout end-string. Nested lists require newlines as delimiters, and * either needs escaping, or put in a literal block. Signed-off-by: Andrew Cooper Acked-by: Stefano Stabellini Reviewed-by: Luca Fancellu --- CC: George Dunlap CC: Jan Beulich CC: Stefano Stabellini CC: Wei Liu CC: Julien Grall CC: Luca Fancellu CC: Henry Wang --- docs/misra/exclude-list.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/misra/exclude-list.rst b/docs/misra/exclude-list.rst index 42dbceb82523..a63b128c3d27 100644 --- a/docs/misra/exclude-list.rst +++ b/docs/misra/exclude-list.rst @@ -44,10 +44,11 @@ Here is an explanation of the fields inside an object o= f the "content" array: their results. This field is optional and when not specified, it means = every checker will use that entry. Current implemented values for this field are: + - xen-analysis: the xen-analysis.py script exclude this entry for both= MISRA and static analysis scan. (Implemented only for Cppcheck tool) =20 To ease the review and the modifications of the entries, they shall be lis= ted in alphabetical order referring to the rel_path field. -Excluded folder paths shall end with '/*' in order to match everything on = that +Excluded folder paths shall end with ``/*`` in order to match everything o= n that folder. --=20 2.30.2 From nobody Tue May 21 16:17:02 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) client-ip=192.237.175.120; envelope-from=xen-devel-bounces@lists.xenproject.org; helo=lists.xenproject.org; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=pass(p=reject dis=none) header.from=citrix.com ARC-Seal: i=1; a=rsa-sha256; t=1699457296; cv=none; d=zohomail.com; s=zohoarc; b=Z1YDCe+aQp3/iYOVZNb2k9Ia50cB5uSpL8MIq6Gz33KXLl1R/2BKdauB3aAcGLdXZ4wKkK0IqIV0Eb5cUPkf2zUfhX9wYmKUOZ3WPAa/x4TZvafSbzEHnL9PXs1SFopCOau8o/R3mIMdCxCZhPtlSc24e7U2K4OZeTdVhkwAK8I= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1699457296; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=gEIwtgNyiAUCXTKL2nxAdni1MdXAJna03xYZF/Hf69c=; b=QCm5b00eIlv2PQ+yo0Xr25zriZcwY58eWK0wEDRn+pRjav0P9dfBWVj7i95rAx14d988/I6BSOA/ohvdOXIsXzgiJBW9ZZgLwVkzzSUvGCk67ENpNLeiw/4VL0xVy3I3bx62dRFys04v3BXj94C1jgsyOWplDDXN+HL0P7/xO3o= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) by mx.zohomail.com with SMTPS id 1699457296686106.30726786328864; Wed, 8 Nov 2023 07:28:16 -0800 (PST) Received: from list by lists.xenproject.org with outflank-mailman.629318.981449 (Exim 4.92) (envelope-from ) id 1r0kT7-000227-1k; Wed, 08 Nov 2023 15:27:49 +0000 Received: by outflank-mailman (output) from mailman id 629318.981449; Wed, 08 Nov 2023 15:27:49 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r0kT6-00021u-V4; Wed, 08 Nov 2023 15:27:48 +0000 Received: by outflank-mailman (input) for mailman id 629318; Wed, 08 Nov 2023 15:27:47 +0000 Received: from se1-gles-sth1-in.inumbo.com ([159.253.27.254] helo=se1-gles-sth1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r0kT5-0001ly-Rz for xen-devel@lists.xenproject.org; Wed, 08 Nov 2023 15:27:47 +0000 Received: from esa6.hc3370-68.iphmx.com (esa6.hc3370-68.iphmx.com [216.71.155.175]) by se1-gles-sth1.inumbo.com (Halon) with ESMTPS id 5ddab65b-7e4b-11ee-98da-6d05b1d4d9a1; Wed, 08 Nov 2023 16:27:47 +0100 (CET) X-Outflank-Mailman: Message body and most headers restored to incoming version X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 5ddab65b-7e4b-11ee-98da-6d05b1d4d9a1 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=citrix.com; s=securemail; t=1699457267; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=U47fe4dzuabd1XFgAOtn7u1DE8NYVen41zChGJGziKI=; b=PBzF73DXN34vnYPjlJOfF/Ze+Sn5Gt+L75REOpo9XIxFDNwtisMI6eqY Xn8qF1yoaVbxiUnKPXj20c/KQi3+H5jVT7hWCJD7y3ljQpBu3cKhkxsKH Gvl2SUUctACm1NDG3Bcuw4ziefjYy2cM12nUNcSsgwTzAlw53pzIlClxk 4=; X-CSE-ConnectionGUID: O7ec57rRToercaUqjXa8Kg== X-CSE-MsgGUID: 0iuvoY++SsqqxftDbraSTQ== Authentication-Results: esa6.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none X-SBRS: 4.0 X-MesageID: 127132502 X-Ironport-Server: esa6.hc3370-68.iphmx.com X-Remote-IP: 162.221.159.70 X-Policy: $RELAYED X-ThreatScanner-Verdict: Negative IronPort-Data: A9a23:ZEL4CaIDtQYfU0cLFE+R6pUlxSXFcZb7ZxGr2PjKsXjdYENS1TJUy DMWCjiBOqqIMGametB2bt7k8EkOuZXRnN9kGgtlqX01Q3x08seUXt7xwmUcnc+xBpaaEB84t ZV2hv3odp1coqr0/0/1WlTZhSAhk/nOHvylULKs1hlZHWdMUD0mhQ9oh9k3i4tphcnRKw6Ws Jb5rta31GWNglaYCUpKrfrYwP9TlK6q4mhB5wRuPakjUGL2zBH5MrpOfcldEFOgKmVkNrbSb /rOyri/4lTY838FYj9yuu+mGqGiaue60Tmm0hK6aYD76vRxjnVaPpIAHOgdcS9qZwChxLid/ jnvWauYEm/FNoWU8AgUvoIx/ytWZcWq85efSZSzXFD6I+QrvBIAzt03ZHzaM7H09c5QXmxFq KMCEgwKYwqIjt+vwoKyGspj05FLwMnDZOvzu1llxDDdS/0nXYrCU+PB4towMDUY354UW6yEP oxANGspM0yojx5nYz/7DLoXmuuyi2a5WDpfsF+P/oI84nTJzRw327/oWDbQUoXQGpwOxBvA/ Aoq+UyhAwwEM+3cigGe62u8iPPjlznyY74rQejQGvlC3wTImz175ActfUu2p7y1h1CzX/pbK lcI4Ww+oK4q7kupQ9LhGRqirxasnDQRRt5RGO0S8xyWx+zf5APxLnMfUjdLZdgitck3bT8nz FmEm5XuHzMHmKKRYWKQ8PGTtzzaESoIKW4PYwcUQA1D5MPsyKkTgxTVX5BcGai6ptTvHHf7x DXikcQlr+xN14hRjfz9pA2WxW30znTUcuIrziKIU2n4sRlDWImofYeh1EHZ3f8QD4nMGzFto 0M4d9iiAPEmVM/cxXDUHb1RTdlF9N7fbmeA3wQH840JsmT1oSD+J+i89RknfB8xWvvobwMFd 6M6Vel5z5hJNX/iVrdtYoS+EKzGJoC7Toy6D5g4gjdUC6WdlTNrHwk0PiZ8J0i3zCARfVgXY P93i/qEA3cAErhAxzGrXeob2rJD7nlglDKIFcqjn0v6i+X2iJuppVAtaQTmUwzExPrZ+1u9H yh3bKNmNCmzoMWhO3KKoOb/3HgBLGQhBICeliCkXrfrH+aSI0l4U6W56ep4K+RYc1F9yr+gE oeVBhUJlzISRBTvdW23V5yUQOq1As8h9CxkYHdE0JTB8yFLXLtDJZw3L/MfFYTLPsQ5pRKoZ 5Hpo/m9P8k= IronPort-HdrOrdr: A9a23:CS1+y6jqBP8XyE0BVh+KQrXs53BQX8d23DAbv31ZSRFFG/FwyP rDoB1L73LJYWgqMk3IwerwQZVoMkmsjaKdgLNhdItKOTOM11dAQ7sSiLcKrwePJ8S6zJ866U 4CSdk3NDSTNykfsS+S2mDRLz9j+qjhzEnBv5ab854Hd2FXgtRbnmVE43GgYy5LrWd9ZKYRJd 653I5qtjCgcXMYYoCSAWQEZfHKo5nmhY/rehkPAj8g8U2rgSmz4LD3PhCE1lNGOgk/i4sKwC zgqUjU96+ju/a0xlv10HLS1Y1fnJ/M28ZOH8uFj+kSM3HJhhyzbIpsdrWetHQeof2p6nwtjN 7Qyi1QdPhb2jf0RCWYsBHt0w7v3HIF8Hn502KVhnPlvIjQWC86I9Apv/MVTjLpr24b+P1s2q NC2GyU87BNCwnboSj779/UEzl3i0uPp2Y4m+J7tQ0SbWJeUs4fkWUsxjIVLH4yJlO71GnhKp gsMCjo3ocZTbpdVQGagoAg+q3oYp15JGb8fqFLgL3u79EepgEE86MVqfZv40so5dYzTYJJ6P /DNbktnLZSTtUOZaY4H+sZR9CrY1a9NS4kHVjiU2gPLpt3Tk7lutry+vE49euqcJsHwN87n4 nASkpRsSo3d1j1AcOD0ZVX+lSVKV/NKwjF24Vb/dx0q7f8TL3kPWmKT00vidKpp7EaDtfAU/ i+NZpKC7voLHfoG4xOwwriMqMiXkU2QYkQoJI2SliOqsXEJsnjsfHaau/aIP73HTMtSgrEcw g+tfjIVbV9B2yQKw7FaULqKgzQk2TEjOxNLJQ= X-Talos-CUID: =?us-ascii?q?9a23=3AH/swPmk5vMOlI+OWDsMy0bAl2WTXOVqCwXyNfFW?= =?us-ascii?q?CNWFkUracdEaSyKo0sMU7zg=3D=3D?= X-Talos-MUID: 9a23:8voECgWPTi9aDWfq/GftmS9lBYQr2L+3EVADjbkMocC/CRUlbg== X-IronPort-AV: E=Sophos;i="6.03,286,1694750400"; d="scan'208";a="127132502" From: Andrew Cooper To: Xen-devel CC: Andrew Cooper , George Dunlap , Jan Beulich , "Stefano Stabellini" , Wei Liu , Julien Grall , Henry Wang Subject: [PATCH for-4.18 3/3] docs/sphinx: Fix indexing Date: Wed, 8 Nov 2023 15:27:27 +0000 Message-ID: <20231108152727.58764-4-andrew.cooper3@citrix.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20231108152727.58764-1-andrew.cooper3@citrix.com> References: <20231108152727.58764-1-andrew.cooper3@citrix.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @citrix.com) X-ZM-MESSAGEID: 1699457298535100003 Content-Type: text/plain; charset="utf-8" sphinx-build reports: docs/designs/launch/hyperlaunch.rst: WARNING: document isn't included in = any toctree docs/designs/launch/hyperlaunch-devicetree.rst: WARNING: document isn't i= ncluded in any toctree docs/misc/xen-makefiles/makefiles.rst: WARNING: document isn't included i= n any toctree docs/misra/C-language-toolchain.rst: WARNING: document isn't included in = any toctree docs/misra/C-runtime-failures.rst: WARNING: document isn't included in an= y toctree docs/misra/documenting-violations.rst: WARNING: document isn't included i= n any toctree docs/misra/exclude-list.rst: WARNING: document isn't included in any toct= ree docs/misra/xen-static-analysis.rst: WARNING: document isn't included in a= ny toctree Create an up-to-date index.rst in misra/ create an "unsorted docs" section = at the top level to contain everything else. They can be re-filed at a later date. Signed-off-by: Andrew Cooper Acked-by: Stefano Stabellini --- CC: George Dunlap CC: Jan Beulich CC: Stefano Stabellini CC: Wei Liu CC: Julien Grall CC: Henry Wang --- docs/index.rst | 13 +++++++------ docs/misra/index.rst | 18 ++++++++++++++++++ 2 files changed, 25 insertions(+), 6 deletions(-) create mode 100644 docs/misra/index.rst diff --git a/docs/index.rst b/docs/index.rst index f3f779f89ce5..22fdde80590c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -53,17 +53,18 @@ kind of development environment. hypervisor-guide/index =20 =20 -MISRA C coding guidelines -------------------------- +Unsorted documents +------------------ =20 -MISRA C rules and directive to be used as coding guidelines when writing -Xen hypervisor code. +Documents in need of some rearranging. =20 .. toctree:: :maxdepth: 2 =20 - misra/rules - misra/deviations + designs/launch/hyperlaunch + designs/launch/hyperlaunch-devicetree + misc/xen-makefiles/makefiles + misra/index =20 =20 Miscellanea diff --git a/docs/misra/index.rst b/docs/misra/index.rst new file mode 100644 index 000000000000..c59730c46d88 --- /dev/null +++ b/docs/misra/index.rst @@ -0,0 +1,18 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +MISRA C coding guidelines +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D + +MISRA C rules and directive to be used as coding guidelines when writing +Xen hypervisor code. + +.. toctree:: + :maxdepth: 2 + + rules + deviations + C-language-toolchain + C-runtime-failures + documenting-violations + exclude-list + xen-static-analysis --=20 2.30.2