Re: [PATCH] CODING_STYLE: Add a section of the naming convention

From: Luca Fancellu <Luca.Fancellu@arm.com>
To: Julien Grall <julien@xen.org>
Cc: Xen-devel <xen-devel@lists.xenproject.org>,
	Julien Grall <jgrall@amazon.com>,
	Andrew Cooper <andrew.cooper3@citrix.com>,
	George Dunlap <george.dunlap@citrix.com>,
	Jan Beulich <jbeulich@suse.com>,
	Stefano Stabellini <sstabellini@kernel.org>, Wei Liu <wl@xen.org>
Subject: Re: [PATCH] CODING_STYLE: Add a section of the naming convention
Date: Mon, 4 Dec 2023 11:20:25 +0000	[thread overview]
Message-ID: <956BC72E-0898-490F-9881-226EE7224F94@arm.com> (raw)
In-Reply-To: <0e20592b-9800-4b9d-9f2f-a996f9ac00bd@xen.org>

> On 1 Dec 2023, at 18:49, Julien Grall <julien@xen.org> wrote:
> 
> 
> 
> On 01/12/2023 18:47, Julien Grall wrote:
>> From: Julien Grall <jgrall@amazon.com>
>> Several maintainers have expressed a stronger preference
>> to use '-' when in filename and option that contains multiple
>> words.
>> So document it in CODING_STYLE.
>> Signed-off-by: Julien Grall <jgrall@amazon.com>
>> ---
>>  CODING_STYLE | 9 +++++++++
>>  1 file changed, 9 insertions(+)
>> diff --git a/CODING_STYLE b/CODING_STYLE
>> index ced3ade5a6fb..afd09177745b 100644
>> --- a/CODING_STYLE
>> +++ b/CODING_STYLE
>> @@ -144,6 +144,15 @@ separate lines and each line should begin with a leading '*'.
>>   * Note beginning and end markers on separate lines and leading '*'.
>>   */
>>  +Naming convention
>> +-----------------
>> +
>> +When command line option or filename contain multiple words, a '-'
>> +should be to separate them. E.g. 'timer-works'.
>> +
>> +Note that some of the option and filename are using '_'. This is now
>> +deprecated.
> 
> Urgh, I sent the wrong draft :(. This is the wording I wanted to propose:
> 
> +Naming convention
> +-----------------
> +
> +'-' should be used to separate words in commandline options and filenames.
> +E.g. timer-works.
> +
> +Note that some of the options and filenames are using '_'. This is now
> +deprecated.
> +
> 

Hi Julien,

Can we make an exception for python files that are meant to be used as module?
Because modules containing ‘-‘ cannot be imported using ‘import’ keyword and
needs another way to do them which is not conventional

Cheers,
Luca

> Cheers,
> 
> -- 
> Julien Grall
> 