[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 1/2] docs/misra: introduce rules.rst
- To: Julien Grall <julien@xxxxxxx>
- From: Jan Beulich <jbeulich@xxxxxxxx>
- Date: Mon, 30 May 2022 11:16:56 +0200
- Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=suse.com; dmarc=pass action=none header.from=suse.com; dkim=pass header.d=suse.com; arc=none
- Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; 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=KvHV05W7r0oNDbvKIvPwBX3cTsKAL6QeC/R0z6RZ6uI=; b=iZZUvyYQ/ODYvCMws9dsquJJu1eXgnGNK6DFOm4NLB2XnbMvuIg+VNxX4OZDRbiT83/OuFp+PVCjgsoXep6ErTrlyzyHj0tPiTp5pMRZWYROvGHiNqE7sAn6an/un2Lhv4Nw9RdjbmSqnIb1UYiGi0sEtnsEYWlsOnU0ON3LN0PN/jiFdXvsZj1CIok3SteQmdCX4F2ZJthiYYS05zRNOSRDh+aa4AAbAoEb53WG7O6pVqYQSbRX+8OaAopvzOysuht8qvARAureDOhbDTVI/ENKe3kuJ9oaxZyMsmwWBBWXFfIcNSd/3JMVIpVne5xoCjJyTQvaBh6bV+kiXqD+Fw==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=iE/z9nUAa5MQDRrchdQaNbf89+BvCN25yvizK02XwM1ZNXXLkT3y/Q9ukFCTdM1Da7SxCvTrw6yooTjJH8+t436E0ILl1XN8aKEofG20wEWKTvbOTuo7WGuJRYFG1PRwxrNOatnXQp6zBeE0l5K7B7g546WXuzf1FnL0sG73PXKqIbUlRLwG5I/h7gEZLWf7NIwyIYMbPhvnKvwmVNxpGdl0LLXh2NQyGOvtAWX8ewtcGTmfcEKz1kCH4UB/hv0wN42uSFT0Ed3O0zGg+hskGCLvzEPSIwri34LSGFsL0xQVTuzKadU8EdzlkrCsiFmnLuvNHw0Xy27Omiaddhuotw==
- Authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=suse.com;
- Cc: Bertrand Marquis <Bertrand.Marquis@xxxxxxx>, "xen-devel@xxxxxxxxxxxxxxxxxxxx" <xen-devel@xxxxxxxxxxxxxxxxxxxx>, "andrew.cooper3@xxxxxxxxxx" <andrew.cooper3@xxxxxxxxxx>, "roger.pau@xxxxxxxxxx" <roger.pau@xxxxxxxxxx>, "George.Dunlap@xxxxxxxxxx" <George.Dunlap@xxxxxxxxxx>, Stefano Stabellini <stefano.stabellini@xxxxxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>
- Delivery-date: Mon, 30 May 2022 09:17:08 +0000
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
On 30.05.2022 11:12, Julien Grall wrote:
> On 28/05/2022 00:16, Stefano Stabellini wrote:
>> """
>> It is possible that in specific circumstances it is best not to follow a
>> rule because it is not possible or because the alternative leads to
>> better code quality. Those cases are called "deviations". They are
>> permissible as long as they are documented, either as an in-code comment
>> or as part of the commit message. Other documentation mechanisms are
>
> I would drop the "as part of the commit message" because it is a lot
> more difficult to associate the deviation with a rationale (the code may
> have been moved and you would need to go through the history).
But this was added in response to me pointing out that code comments
aren't standardized yet as to their format. The alternative, as said
before, would be to come up with a scheme first, before starting to
mandate playing by certain of the rules (and hence requiring deviations
to be documented).
Jan
|
