[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH v3] docs/misra: fix sphinx-build issues


  • To: "xen-devel@xxxxxxxxxxxxxxxxxxxx" <xen-devel@xxxxxxxxxxxxxxxxxxxx>
  • From: Dmytro Prokopchuk1 <dmytro_prokopchuk1@xxxxxxxx>
  • Date: Sun, 24 Aug 2025 17:53:20 +0000
  • Accept-language: en-US, uk-UA, ru-RU
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=epam.com; dmarc=pass action=none header.from=epam.com; dkim=pass header.d=epam.com; arc=none
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=LGFWGOFhoclq3cZCxDPviK6AXxSaMGJkGxTF99FsKGo=; b=WOvTI1zxYbiEhdZ9QybysApqiwgUs/XeddsM4PfLNNd+gjNG+M9boyevLdTzePGeTITlgC+qMqqyhrcmUlb+I1FcJzhXAVsqAZa6WxG0mMFjQV/3BaKBjbTsqc5/TuRW/Ab9b5iv3uW7Xl7ucIN4GJa9Ds71pCFwTQGdzKpMSVhOUWnvnXmHy1VWQp7U2JeY/Tn+Ng/IJ70tsnfQIo4H2IcFBbGungJYeT75TShr2Qqo1QY/81YKPb4T7wbVjKn/Qae1FZED7cOdTrqAN3xcZPtKonkPyOtYjePcDjwC9VErT6HSamhj2aNbuDJOrDbVnQMvbSGYLuz/2MDNUzwYUQ==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=Fag1xTe0juXWjODeB8SbTUDqmsb5cTPq/J1sp/4mBsNMQL9OdkgBCPZFW1FwxcV6UrMFMBdPBeW2507YXxmWWnvRpuPRq4rznyNLQ7lyn90AH8Cqc+tHvtxNxuAEyiNeRzPlU0+ntL2czJCU4ItpFD6pqFc1OESgeuovNuACMaerUX6gRWYjdr6KHXq+ehybWrrBQXLjHzgk87DRRnR/VDeUmu621T61nZFAxL+pWxi11FdOZkIUrwxjc6pow+HzQvUAEIYfQAqC71/iMC7uMCILA3uf0mI4P6CQcxjDWRzqe/vrXX1p93wo0WL6O0e9f0zmvrYGqqRIO/eYeZY5xA==
  • Authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=epam.com;
  • Cc: Dmytro Prokopchuk1 <dmytro_prokopchuk1@xxxxxxxx>, Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, Anthony PERARD <anthony.perard@xxxxxxxxxx>, Michal Orzel <michal.orzel@xxxxxxx>, Jan Beulich <jbeulich@xxxxxxxx>, Julien Grall <julien@xxxxxxx>, Roger Pau Monné <roger.pau@xxxxxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx>
  • Delivery-date: Sun, 24 Aug 2025 17:53:35 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
  • Thread-index: AQHcFR/6qKs/+WblEk+6G3rdASWMgg==
  • Thread-topic: [PATCH v3] docs/misra: fix sphinx-build issues

From: Dmytro Prokopchuk1 <dmytro_prokopchuk1@xxxxxxxx>

Fix the following issues:
1. xen/docs/misra/deviations.rst:90: WARNING: Inline interpreted text or
phrase reference start-string without end-string. [docutils]
2. xen/docs/misra/deviations.rst:54: ERROR: Error parsing content block
for the "list-table" directive: uniform two-level bullet list expected,
but row 6 does not contain the same number of items as row 1 (2 vs 3).
* - R2.1
  - Calls to the `__builtin_unreachable()` function inside the expansion of
    the `ASSERT_UNREACHABLE()` macro may cause a function to be marked as
    non-returning. This behavior occurs only in configurations where
    assertions are enabled. To address this, the `noreturn` property for
    `__builtin_unreachable()` is overridden in these contexts, resulting in
    the absence of reports that do not have an impact on safety, despite
    being true positives.
    Xen expects developers to ensure code remains safe and reliable in builds,
    even when debug-only assertions like `ASSERT_UNREACHABLE() are removed.
3. xen/docs/misra/rules.rst:127: WARNING: Inline interpreted text or phrase
reference start-string without end-string. [docutils]

Signed-off-by: Dmytro Prokopchuk <dmytro_prokopchuk1@xxxxxxxx>
Reviewed-by: Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx>
Reviewed-by: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
---
Changes in v3:
- removed item #4 from commit message
- set backticks for macro ASSERT_UNREACHABLE() in deviations.rst and rules.rst

Link to v2:
https://patchew.org/Xen/f31b8d62f16bd272114276f53db842101cd53e52.1755266805.git.dmytro._5Fprokopchuk1@xxxxxxxx/
---
 docs/misra/deviations.rst | 3 ++-
 docs/misra/rules.rst      | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/docs/misra/deviations.rst b/docs/misra/deviations.rst
index 2119066531..3271317206 100644
--- a/docs/misra/deviations.rst
+++ b/docs/misra/deviations.rst
@@ -95,7 +95,8 @@ Deviations related to MISRA C:2012 Rules:
        the absence of reports that do not have an impact on safety, despite
        being true positives.
        Xen expects developers to ensure code remains safe and reliable in 
builds,
-       even when debug-only assertions like `ASSERT_UNREACHABLE() are removed.
+       even when debug-only assertions like `ASSERT_UNREACHABLE()` are removed.
+     - ECLAIR has been configured to ignore those statements.
 
    * - R2.2
      - Proving compliance with respect to Rule 2.2 is generally impossible:
diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst
index a2e4e9f4ff..4388010ec9 100644
--- a/docs/misra/rules.rst
+++ b/docs/misra/rules.rst
@@ -124,7 +124,7 @@ maintainers if you want to suggest a change.
            they are used to generate definitions for asm modules
          - Declarations without initializer are safe, as they are not
            executed
-         - Functions that are no-return due to calls to the 
`ASSERT_UNREACHABLE()'
+         - Functions that are no-return due to calls to the 
`ASSERT_UNREACHABLE()`
            macro in debug build configurations are not considered violations::
 
               static inline bool
-- 
2.43.0



 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.