From: Jan Beulich <jbeulich@suse.com>
To: Julien Grall <julien@xen.org>
Cc: Julien Grall <jgrall@amazon.com>,
Andrew Cooper <andrew.cooper3@citrix.com>,
George Dunlap <george.dunlap@citrix.com>,
Stefano Stabellini <sstabellini@kernel.org>, Wei Liu <wl@xen.org>,
xen-devel@lists.xenproject.org
Subject: Re: [PATCH] CODING_STYLE: Add a section of the naming convention
Date: Tue, 5 Dec 2023 08:41:07 +0100 [thread overview]
Message-ID: <b5de9652-c421-4236-90d6-3d166a006e0c@suse.com> (raw)
In-Reply-To: <f40d6838-9a82-48cd-9a6b-a298c281f8cf@xen.org>
On 04.12.2023 20:05, Julien Grall wrote:
> On 04/12/2023 09:39, Jan Beulich wrote:
>> On 01.12.2023 19:49, Julien Grall wrote:
>>> +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.
>>
>> I certainly appreciate and second the intent, yet I'm afraid "Naming convention"
>> in the doc would (to me at least) first and foremost talk about identifiers used
>> in the various source files. If this really is to be about only file names and
>> command line options, then I think the heading would better say so. Alternatively
>> a clear indication would want adding that text about identifiers is supposed to
>> be here, but is yet to be written. (The text itself, for the intended purpose, > reads fine to me, fwiw.)
>
> Right now, I don't have any plan to document the naming convention for
> identifiers. In fact, I don't know if we have one...
>
> So how about renaming the section to:
>
> "Naming convention for files and comand line options"
That would be fine with me (with - nit - "command"). Then
Acked-by: Jan Beulich <jbeulich@suse.com>
Jan
next prev parent reply other threads:[~2023-12-05 7:41 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-01 18:47 [PATCH] CODING_STYLE: Add a section of the naming convention Julien Grall
2023-12-01 18:49 ` Julien Grall
2023-12-04 9:39 ` Jan Beulich
2023-12-04 19:05 ` Julien Grall
2023-12-05 7:41 ` Jan Beulich [this message]
2023-12-04 11:20 ` Luca Fancellu
2023-12-04 11:31 ` Julien Grall
2023-12-04 11:46 ` Luca Fancellu
2023-12-05 18:12 Julien Grall
2023-12-06 2:21 ` George Dunlap
2023-12-06 8:41 ` Jan Beulich
2023-12-06 11:19 ` Andrew Cooper
2023-12-06 11:22 ` Julien Grall
2023-12-06 16:22 ` George Dunlap
2023-12-07 14:35 ` Julien Grall
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b5de9652-c421-4236-90d6-3d166a006e0c@suse.com \
--to=jbeulich@suse.com \
--cc=andrew.cooper3@citrix.com \
--cc=george.dunlap@citrix.com \
--cc=jgrall@amazon.com \
--cc=julien@xen.org \
--cc=sstabellini@kernel.org \
--cc=wl@xen.org \
--cc=xen-devel@lists.xenproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.