From nobody Mon May 13 23:49:26 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) client-ip=192.237.175.120; envelope-from=xen-devel-bounces@lists.xenproject.org; helo=lists.xenproject.org; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org ARC-Seal: i=1; a=rsa-sha256; t=1701456483; cv=none; d=zohomail.com; s=zohoarc; b=TPauPUxQtntA8NqR9oXAC+wrVXa2kFJU6EmrYfaJKiER6WEYXArCaUjqi+hf/Idde1QHi6lUlYwRfuhTqqFBPp7ztlqsjZ64BYPg7b+VpmLCTGScPpjJ4BpJ3RvfkHABpq9+6/H63q1zVmVSXbgpjIGdWLGuf9vCkMaydYeFL48= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1701456483; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:List-Subscribe:List-Post:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=ndxVU3EWahiDQSPaDNSsgeLeNuG+m3VG8dgm4KveLBw=; b=JSFfkPzUcO+aM+GkykCWW5t8Gzu+zSQGB5MR/BI3ace9d/ylfqIa0TOgyLyu6jlZsjCG1Iv2F0f9N2nog+4+CTxkQxWH599s7vH++q6Uf02swjLWEhUEBQJQgZqBlWfw/DflUwRc447gbAGQ67zc3NJ1ybnskaK652+6YiMPrIw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Return-Path: Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) by mx.zohomail.com with SMTPS id 1701456483424781.8042342033408; Fri, 1 Dec 2023 10:48:03 -0800 (PST) Received: from list by lists.xenproject.org with outflank-mailman.645647.1007857 (Exim 4.92) (envelope-from ) id 1r98Y6-0007CR-HW; Fri, 01 Dec 2023 18:47:38 +0000 Received: by outflank-mailman (output) from mailman id 645647.1007857; Fri, 01 Dec 2023 18:47:38 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r98Y6-0007CK-D7; Fri, 01 Dec 2023 18:47:38 +0000 Received: by outflank-mailman (input) for mailman id 645647; Fri, 01 Dec 2023 18:47:37 +0000 Received: from mail.xenproject.org ([104.130.215.37]) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r98Y5-0007CE-7b for xen-devel@lists.xenproject.org; Fri, 01 Dec 2023 18:47:37 +0000 Received: from xenbits.xenproject.org ([104.239.192.120]) by mail.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r98Y4-00062A-SO; Fri, 01 Dec 2023 18:47:36 +0000 Received: from 54-240-197-232.amazon.com ([54.240.197.232] helo=dev-dsk-jgrall-1b-035652ec.eu-west-1.amazon.com) by xenbits.xenproject.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.92) (envelope-from ) id 1r98Y4-0000Np-Hr; Fri, 01 Dec 2023 18:47:36 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=xen.org; s=20200302mail; h=Content-Transfer-Encoding:MIME-Version:Message-Id:Date: Subject:Cc:To:From; bh=ndxVU3EWahiDQSPaDNSsgeLeNuG+m3VG8dgm4KveLBw=; b=grs4Uq RPBPjd0ayV8k4tc21JHaNE4tIi4aOVXx4F/iwEp7AmDrEAOEyupLc1Mj/bR03WCZtXy89YliIjK1N /lVTNLS1NBhwQKlJnOTb156qgZ03zlkTd5vYYPF4XRPHiTUW0aEcKvOfHrhTex8o0f3toRQdsq8J/ Lcp/Hsa3cc0=; From: Julien Grall To: xen-devel@lists.xenproject.org Cc: julien@xen.org, Julien Grall , Andrew Cooper , George Dunlap , Jan Beulich , Stefano Stabellini , Wei Liu Subject: [PATCH] CODING_STYLE: Add a section of the naming convention Date: Fri, 1 Dec 2023 18:47:28 +0000 Message-Id: <20231201184728.31766-1-julien@xen.org> X-Mailer: git-send-email 2.40.1 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @xen.org) X-ZM-MESSAGEID: 1701456484918000001 Content-Type: text/plain; charset="utf-8" From: Julien Grall 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 Acked-by: Jan Beulich --- 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 leadi= ng '*'. * Note beginning and end markers on separate lines and leading '*'. */ =20 +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. + Emacs local variables --------------------- =20 --=20 2.40.1