[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] docs/misra: fix sphinx-build issues
- To: Jan Beulich <jbeulich@xxxxxxxx>
- From: Dmytro Prokopchuk1 <dmytro_prokopchuk1@xxxxxxxx>
- Date: Fri, 15 Aug 2025 12:42:52 +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=XDX5wp7U2xAGP+dZo93+QLdtOQKpnjOTLlywuDupMiI=; b=WInBEecVOjGGrXihnHpMSWBpe9t1yftb3I5GTROTFCE7nPmffdp1c6DGSMsQZRo8HJOYXRZoeHxffUJBzQFhBqlezb3vBI4/gsjMEB2Ej0rdF8c5xfoisqNbcS4QlmaS4icr6hSX+SMy8n+SFajLWOmBH07KLcKYqUx8/E0dPYHUDH0+0+TrExnxfpZqxM1TQcFhO0M0ivOAQteytZV0x5GT8a5PUUScHwDScT1tNErhu9PJklmrgv1N8rE4zA+KifAogbAngHWig3g+1nUGJyIc6niIBho5PZ4hz/HNjV40/8KXTne7uglIQL/ufH9bIgnaA72kN/lKy/r+lLKfVQ==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=udISKfU6agoHBQmQrBXwBvgJhCjdwGIM7CLticz4SpMFaNVsd7j0ziWxdh8yhW8VCW9ks9V0TKb4n0vVwCboPs6veco9iqizm4BAaFKy7NaHenarp6OaNgw1p7AFUhUKmkRxSCU32FwvJ5GRvRDa4m/K0RTtHEzdSdGxiJSxGBJ/AqiZmns6A4IrFj3iK7C1+QkQk6CBP5toEdAOoeP+O65VCOzKflqsGWcg4H4xQwPLPA7yBBhcEoa11EnREiXLn9tJ8aCN4m/Z+O4muoh3N9H8LR9ho3w3b25HlQqL+HiDVr4S3ki6dxqI8LFOPEKW1sdByVifo4K/CwSG5mqWug==
- Authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=epam.com;
- Cc: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, Anthony PERARD <anthony.perard@xxxxxxxxxx>, Michal Orzel <michal.orzel@xxxxxxx>, Julien Grall <julien@xxxxxxx>, Roger Pau Monné <roger.pau@xxxxxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, "xen-devel@xxxxxxxxxxxxxxxxxxxx" <xen-devel@xxxxxxxxxxxxxxxxxxxx>
- Delivery-date: Fri, 15 Aug 2025 12:43:01 +0000
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
- Thread-index: AQHcDbJCdYlsiZdfl0mX5ViIXi0+6LRjZcaAgAAeAoCAACUOAA==
- Thread-topic: [PATCH] docs/misra: fix sphinx-build issues
On 8/15/25 13:30, Dmytro Prokopchuk wrote:
>
>
> On 8/15/25 11:42, Jan Beulich wrote:
>> On 15.08.2025 09:00, Dmytro Prokopchuk1 wrote:
>>> --- 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.
>>
>> Mind me asking why one form of quoting is used here (using back-tick),
>> while ...
>>
>>> --- 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()'
>>
>> ... another is used here (single quotes)?
>>
>> Jan
>
> Good question...
> I'll align a style.
>
> Dmytro.
Well, the deviations.rst and rules.rst files have a mixed style.
Sometimes file names are in '', and sometimes in ``.
The same inconsistency applies to referring to code.
Any style suggestions?
Dmytro.
|
