From nobody Mon May 13 02:20:48 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=1701799975; cv=none; d=zohomail.com; s=zohoarc; b=bEA5717h3NSSBYVUFVKeiU3Fbm0Brf6GwweZxpyerNWfI+CJN9ICnpaXlaBcNZoYJ7BDOkOqtK8jRwyjJY1upvgujzZDd4fV6OwBLxifgdooxc522eerk1q3k3Qb+IzqkajuxBxm6YYtIOZv+AhXvgT2fbgTg4aTa2pxbwnLYJk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1701799975; 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=P5Xze86EjvxFXEoGvxJ0ZNh6IeY9VP72gpznJ61IUMI=; b=EEeREs/j4ZbHRXwNpSeKf4NOGMPzcU0Ac4nf5UaGd/JEoqF7BD7Sv4EYi/dHKzlFW4qIc+BvhEirbsQor7MWYq8+dS5WsX5jsAScbEFX3ANQHZeXse1mn9iWH2iKkqhTMWU0WbgFbtkCEJ6K/qAiZH+/7Ij3mXwh0JJC+aOJ2OY= 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 1701799975008956.1092222068495; Tue, 5 Dec 2023 10:12:55 -0800 (PST) Received: from list by lists.xenproject.org with outflank-mailman.648179.1012259 (Exim 4.92) (envelope-from ) id 1rAZuB-0007so-Nb; Tue, 05 Dec 2023 18:12:23 +0000 Received: by outflank-mailman (output) from mailman id 648179.1012259; Tue, 05 Dec 2023 18:12:23 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1rAZuB-0007sh-Kx; Tue, 05 Dec 2023 18:12:23 +0000 Received: by outflank-mailman (input) for mailman id 648179; Tue, 05 Dec 2023 18:12:23 +0000 Received: from mail.xenproject.org ([104.130.215.37]) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1rAZuB-0007sb-2O for xen-devel@lists.xenproject.org; Tue, 05 Dec 2023 18:12:23 +0000 Received: from xenbits.xenproject.org ([104.239.192.120]) by mail.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1rAZuA-0003rD-Nw; Tue, 05 Dec 2023 18:12:22 +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 1rAZuA-0006bU-F3; Tue, 05 Dec 2023 18:12:22 +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=P5Xze86EjvxFXEoGvxJ0ZNh6IeY9VP72gpznJ61IUMI=; b=atlLqf vi8rVvAaZO+1fjOKuO3hO1CZws4Y/sS/eXi50DpnvxcMOC7RSULBgf4uX0291YDQTzivU3zp1xQmY aMFGAMA9LJpvoxGQ8ncwzs04FBW3j6/iEJODFQiOOohAq5X2XYOp0VshAt3QvLxfS9F7faysEMX4R cHWpLD6fx5w=; 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: Tue, 5 Dec 2023 18:12:18 +0000 Message-Id: <20231205181218.74667-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: 1701799977012100001 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 --- Changes in v2: - New wording - Update the section title - Add Jan's acked-by --- CODING_STYLE | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CODING_STYLE b/CODING_STYLE index ced3ade5a6fb..ed13ee2b664b 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 for files and command line options +---------------------------------------------------- + +'-' 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. + Emacs local variables --------------------- =20 --=20 2.40.1