[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 10:30:16 +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=uLjt83miRImh6TpQfMmlfrFQ+IKwp92JkOS2CL55pH4=; b=cDTO48Wg+uavhgDAjBTFVezq4XSOn0zeC1qvHe3uggwsnCbv8r2jxgLac6iaTRArxThBMlAI8k42DIcpXrjFFARfsBE64j7MnCXv11XAK1GtcSEa3ZomUKC8IygGYY4+1hTuaUoUs122vIqFfO3BTpH3EPTnBC9ZakEawJQ1nU1iFkiK0BBwRzHvlLnUSQniBtlqUHAl1vnc2GDs/Y4MvZU5P/qZaTZlAC444dBl0e6BUZdQZ10HQf7faquusgdB+x3S7l5qo+oxpSdrbYLCLMl25mpJwL09hA8JJfex+xjz5p9HpGdWOkJDTmsDfol1kUaQaDWiMLAyPLLQayS30w==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=IMjLmdApv2JgaOaGHQZSgQd118tWfwKU8kwS0UJ7yG7lyy6mV6wIQkGf4vsB6onXR1itnbLUh3ZTHEwkBl7X7rqj6r0E/vlqfVCiCNY5Xrqlk2EXhpEgvVm2fc366CwfYVDAZ/F4qTM2Catc0ykefJE0psNaUdjC7avhwp/WJ0t4Y9G9YWyDTHecr4c8TOZK4NjgB6ozh2P2VcjbVQvkDmW3eVcH/XGzIdHhe3k+xd6vk9pZeQUj8eocpLENXTUHxtLyKsUxENRbJp29eiEJNlK4qwARXWugBO8cQCxQMIFlv9kltSfXF9nyxMm7SY6CW6nVWHCLza1ZvuTUnamRTw==
  • 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 10:30:25 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
  • Thread-index: AQHcDbJCdYlsiZdfl0mX5ViIXi0+6LRjZcaAgAAeAoA=
  • Thread-topic: [PATCH] docs/misra: fix sphinx-build issues


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.

 


Rackspace

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