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

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


  • To: "xen-devel@xxxxxxxxxxxxxxxxxxxx" <xen-devel@xxxxxxxxxxxxxxxxxxxx>
  • From: Dmytro Prokopchuk1 <dmytro_prokopchuk1@xxxxxxxx>
  • Date: Fri, 15 Aug 2025 14:15:50 +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=o+nErdGwgAUFF4kNo/KwOuKnRVxkhgIWh+T2/6wvl/k=; b=gyt7LV7C4/zLNmQAVvGmvFfNC4kqr1advVLIZnuispSjWBNms+LcNuAmn1//l5Sy7vHP1a1trs5wRP6KzaDfHp2WtDrPQWcGIUs2QX7j4lg8NTph957b9VbaFF0ubjxm6DuPucK9bfbjaOtjxeO0CuShcMkWXAWmxbY77j8J0EAQO4CpDu/EL6MLDem6xWACYx5aLshCVYK2Jlub5EhN9uz1ZXoTIS/yLbBIOiprK54LuGLbLszyK2SUGVHUv8maFpyUxto4U5qP8Nqz+fmMPmv6cys3oWDsJjrWnPtaeeA0QdQIdsd0LpQqmuVyASTby5jQ8Wm+7hfQa2hvCefEgg==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=pCENmuG1YzjrspW9iRX6NBdg/LovDvj+Stpg0kU6Mq2PJaXVVuWZfCZPQYJmLs+/kIXN1o1gdgx73oi+e6XFtqZ2ryfbVgHHIjHQazmrbgPqYRY3CR4coKeHvmKqbcNa7OxBozxz7TOmlXUY9aHMY/PbPaUHavx+ks8QRBFGwaCf9R7ei1tLvC37qNqWtGO5igbi4/LbdMLCLJOAdF12H745e/75auqyby73R+BG0cKLWfd0xJZFlnH3+kTC6FjozIZ7Lo6rnRIFs5TubOOQ0GZLwVXJ+a/pJ1VEbkDUpRCCcqVbWmkBDCBy60KWgEMg5x9/jhOYSMQbvCCJ65Vs1w==
  • 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: Fri, 15 Aug 2025 14:16:04 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
  • Thread-index: AQHcDe8as9q/ao3zhECV/xRhyhAMwQ==
  • Thread-topic: [PATCH v2] docs/misra: fix sphinx-build issues

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]
4. remove backticks from references to source code in the file rules.rst
to have a consistent style in this file

Signed-off-by: Dmytro Prokopchuk <dmytro_prokopchuk1@xxxxxxxx>
Reviewed-by: Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx>
Reviewed-by: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
---
Link to v1:
https://patchew.org/Xen/fb809a94e8a50bd3a59aa47ee1832c61af8a9f40.1755241166.git.dmytro._5Fprokopchuk1@xxxxxxxx/

Changes in v2:
- updated commit message (item 4)
- added review tags
- in the file rules.rst, removed backticks from references to source code
---
 docs/misra/deviations.rst | 3 ++-
 docs/misra/rules.rst      | 8 ++++----
 2 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/docs/misra/deviations.rst b/docs/misra/deviations.rst
index 3c46a1e47a..2be49076e1 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 6812eb7e8a..be315bc991 100644
--- a/docs/misra/rules.rst
+++ b/docs/misra/rules.rst
@@ -119,12 +119,12 @@ maintainers if you want to suggest a change.
          - Switch with a controlling value statically determined not to
            match one or more case statements
          - Functions that are intended to be referenced only from
-           assembly code (e.g. 'do_trap_fiq')
+           assembly code (e.g. do_trap_fiq)
          - asm-offsets.c, as they are not linked deliberately, because
            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
@@ -413,8 +413,8 @@ maintainers if you want to suggest a change.
        and any other type
      - All conversions to integer types are permitted if the destination
        type has enough bits to hold the entire value. Conversions to bool
-       and void* are permitted. Conversions from 'void noreturn (*)(...)'
-       to 'void (*)(...)' are permitted.
+       and void* are permitted. Conversions from void noreturn (*)(...)
+       to void (*)(...) are permitted.
 
    * - `Rule 11.2 
<https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_11_02.c>`_
      - Required
-- 
2.43.0



 


Rackspace

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