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

Re: [PATCH 2/2] docs/misra: add Rule 5.1


  • To: Stefano Stabellini <sstabellini@xxxxxxxxxx>
  • From: Jan Beulich <jbeulich@xxxxxxxx>
  • Date: Wed, 25 May 2022 10:08:31 +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=zTa4xJIqbw+9NUeJ00BUAhQdmBU4jn5bKML4SzZSjPI=; b=BrHPRQCT7bfHaxl81jX9EWXV9GSe0QX1PBnQrrf4yiQhReOC4Q7gFlP/Fm5+br0L+DOv+ha3prdhNh3z3HLYqIanE7SuHdtbZZPFJv4Ho7e/HZY9RnIQgLfoAUjYq/VkzNVESHKvVyDbABfFA7ceGvmi6zy8dcTSBBZAbKt+yHDxjxzNzN+BBJbgfrB+pES1MwbX5izHKt/mqjPhfJnmRsdRx6z0qcAdHyEVo+MJ4lHYD7WpjQBrwgeLOJrffNOSwUzLXry/BMsf7DtJh1ucp8ukNI9nwhAphkLsqd47ZOb5kry0jt05FD+h6z+SzC+FeOmnUJEVJD/+H2IPEyzFZQ==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=jAI7zRfj+GBZ3JsW+Ns7LSzpMX/PrrLHA4AILad7z4cJ1q6DCGiBtZEotMUgGvNTzAWaBhZFpKzxpAFftywkDBNonyPcf7D61ubdZPhbcqLqSuAd70uJDN3VpVp4fxofOYjpHRt4FmLWruBt8W8iKV4sFv8gKgA6bQ79X6rY2DfRCPgvgaRcXLJuhE5tgkHT0d7ecP8Ho4boM/1/7ORxaaDdVw+dEyIgHrahW9gBlm8Up+parmOpyUEcmfe54U5kZ4NfI6VPnYnBf6IluWNw/SejAQa6d9sHrBoqw1EYLLHK7BOormn0VV97lTy1a9Y2YeK7kJb/JEuWmmQhxQj+1g==
  • Authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=suse.com;
  • Cc: andrew.cooper3@xxxxxxxxxx, roger.pau@xxxxxxxxxx, julien@xxxxxxx, Bertrand.Marquis@xxxxxxx, George.Dunlap@xxxxxxxxxx, Stefano Stabellini <stefano.stabellini@xxxxxxxxxx>, xen-devel@xxxxxxxxxxxxxxxxxxxx
  • Delivery-date: Wed, 25 May 2022 08:08:43 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>

On 25.05.2022 02:35, Stefano Stabellini wrote:
> From: Stefano Stabellini <stefano.stabellini@xxxxxxxxxx>
> 
> Add Rule 5.1, with the additional note that the character limit for Xen
> is 63 characters.
> 
> The max length identifiers found by ECLAIR are:
> 
> __mitigate_spectre_bhb_clear_insn_start
> domain_pause_by_systemcontroller_nosync
> 
> Both of them are 40 characters long. A limit of 63 characters work for
> the existing code.

I have to admit that it hasn't become clear to me why we want to
permit (if not to say encourage) the use of such long identifiers.
If 40 is the longest we've got, why not limit it to 40 for now
with a goal of further reducing? A 40-char symbol plus some
indentation will already pose problems with 80-char line length.

Otoh, as said on the call, I think the public headers want
mentioning explicitly here in some way. Part of them (most or all
of what's under io/) aren't used when building Xen, so won't be
seen by Eclair (aiui). Yet they are a formal part of the code
base, and e.g. ring.h has some pretty long names (albeit still
below 40 chars as it looks). So once we're able to go down to e.g.
32 for the bulk of the code base, public headers should imo still
be explicitly allowed to use longer identifiers.

Jan




 


Rackspace

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