From patchwork Mon Jul 1 13:46:35 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alessandro Zucchelli X-Patchwork-Id: 13718122 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 5AF17C30653 for ; Mon, 1 Jul 2024 13:48:08 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.751680.1159710 (Exim 4.92) (envelope-from ) id 1sOHNw-0001OU-TG; Mon, 01 Jul 2024 13:48:00 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 751680.1159710; Mon, 01 Jul 2024 13:48:00 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1sOHNw-0001ON-Qo; Mon, 01 Jul 2024 13:48:00 +0000 Received: by outflank-mailman (input) for mailman id 751680; Mon, 01 Jul 2024 13:47:58 +0000 Received: from se1-gles-sth1-in.inumbo.com ([159.253.27.254] helo=se1-gles-sth1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1sOHMi-0007ig-ES for xen-devel@lists.xenproject.org; Mon, 01 Jul 2024 13:46:44 +0000 Received: from support.bugseng.com (mail.bugseng.com [162.55.131.47]) by se1-gles-sth1.inumbo.com (Halon) with ESMTPS id 5a14d170-37b0-11ef-90a5-e314d9c70b13; Mon, 01 Jul 2024 15:46:43 +0200 (CEST) Received: from delta.bugseng.com.homenet.telecomitalia.it (host-79-60-221-62.business.telecomitalia.it [79.60.221.62]) by support.bugseng.com (Postfix) with ESMTPSA id 19E4F4EE0746; Mon, 1 Jul 2024 15:46:41 +0200 (CEST) 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" X-Inumbo-ID: 5a14d170-37b0-11ef-90a5-e314d9c70b13 From: Alessandro Zucchelli To: xen-devel@lists.xenproject.org Cc: consulting@bugseng.com, Alessandro Zucchelli , Andrew Cooper , Jan Beulich , Julien Grall , Stefano Stabellini Subject: [RFC PATCH 17/17] CODING_STYLE: Add a section on header guards naming conventions Date: Mon, 1 Jul 2024 15:46:35 +0200 Message-Id: X-Mailer: git-send-email 2.34.1 In-Reply-To: References: MIME-Version: 1.0 This section explains which format should be followed by header inclusion guards via a drop-down list of rules. No functional change. Signed-off-by: Alessandro Zucchelli --- CODING_STYLE | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/CODING_STYLE b/CODING_STYLE index 7f6e9ad065..87836c97d4 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -167,3 +167,22 @@ the end of files. It should be: * indent-tabs-mode: nil * End: */ + +Header inclusion guards +----------------------- + +Unless differently specified all header files should have proper inclusion +guards in order to avoid being included multiple times. +The following naming conventions have been devised: +- private headers -> __H +- asm-generic headers -> ASM_GENERIC__H + - #ifndef ASM_GENERIC_X86_PERCPU_H + #define ASM_GENERIC_X86_PERCPU_H + //... + #endif /* ASM_GENERIC_X86_PERCPU_H */ +- arch//include/asm//.h -> ASM____H + - #ifndef ASM_X86_DOMAIN_H + #define ASM_X86_DOMAIN_H + //... + #endif /* ASM_X86_DOMAIN_H */ +