From mboxrd@z Thu Jan 1 00:00:00 1970 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.gnu.org (lists.gnu.org [209.51.188.17]) (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 A07FEC77B7C for ; Thu, 20 Apr 2023 15:59:33 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppWf6-0000By-VO; Thu, 20 Apr 2023 11:57:32 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppWf6-0000BO-5E for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:32 -0400 Received: from mail-wm1-x330.google.com ([2a00:1450:4864:20::330]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppWf4-0007um-Jo for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:31 -0400 Received: by mail-wm1-x330.google.com with SMTP id a8-20020a05600c348800b003f17ddb04e3so1380975wmq.2 for ; Thu, 20 Apr 2023 08:57:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682006247; x=1684598247; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Nrpom6SU9io6Y3gUibz5mchgZ9rlSkFFImeDW90ONAA=; b=XcIhGUNaOemHzy+nxsyl+p9N4Z1KraBOcUHw3ogTymi2TmBfHdES6IOO3dokbYRz7A KOJV5Qhf9tEH5baUAfmyVY/eVGLQCsTZWkkxCbG950IiprLOCP/PXMot3tz5gaCq3m9b fB+/dq9/WsXHgzr3pET69BHHVSAOw4xGHlACvTo4aGF2EjRCf3NuWKjkaccwG8VFQby6 pCJqi1myWQHblE2BlIBpAvVdzfzKAIuArTeVlOtPYV83g3m0bqq0DOEdYfanmMxgt0Fq 9gxpRtWQasqoQJzaWGQizXghm29DqK35DJYtjaOoQBUe+rVOhMVc87gNDNGz0zkI+hzu 4pKw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682006247; x=1684598247; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Nrpom6SU9io6Y3gUibz5mchgZ9rlSkFFImeDW90ONAA=; b=UbmMkyowBYdplnW9Gys2Jm9rBkZLa8yzVNF7ZUd8Zwy76wicThpdQzg+J9wKzEjkh8 VdzCSGHhvskAp60J/bmjPx719nUs4FVeh+z7I2n4XRL/XwvkYOVlMyrvTQDwPPjlGltI UqOVMAvx1rBnTtDKiSuo3OCOHRRlwa0HcKVNpLZn0hdbVL1DRipUOMIptw2ZIjWfl9X/ CgipClQRo1urjWKDyt/tAneo3e5Y0bbrybTEJqXcqekh561XaPN/L8vxFZ+KfW3xnPnK CgqWLugD1WZTjRSw54EUcoviCINoYBkWaCKagUFIRBVO7HZlWOTw1C3QA3TsZDZ4Zp90 aArw== X-Gm-Message-State: AAQBX9cIh7fwJHS6WtF21jtZtdyKUB+y2gOYDbTnE26hwpEkKG5ftepU khLJRwywr/eT0bDsyHhFc0TE2g== X-Google-Smtp-Source: AKy350Zwz1VDubWElhYeZ9bHAhLkdt7/oqecdXG626wX4vZ/em4ys/xABC4ftCBCegmyUcRmymy1Jg== X-Received: by 2002:a05:600c:258:b0:3f1:735b:9c4b with SMTP id 24-20020a05600c025800b003f1735b9c4bmr1768256wmj.37.1682006247508; Thu, 20 Apr 2023 08:57:27 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id h16-20020a05600c315000b003f173a2b2f6sm5828196wmo.12.2023.04.20.08.57.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:57:26 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 3617E1FFBF; Thu, 20 Apr 2023 16:57:24 +0100 (BST) From: =?UTF-8?q?Alex=20Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Elena Ufimtseva , =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , peter.maydell@linaro.org, =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Paolo Bonzini , Thomas Huth , Markus Armbruster , Alexandre Iooss , John G Johnson , Jagannathan Raman , Juan Quintela , Eduardo Habkost , Richard Henderson , Mahmoud Mandour Subject: [PATCH 7/9] docs/devel: make a statement about includes Date: Thu, 20 Apr 2023 16:57:21 +0100 Message-Id: <20230420155723.1711048-8-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230420155723.1711048-1-alex.bennee@linaro.org> References: <20230420155723.1711048-1-alex.bennee@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2a00:1450:4864:20::330; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x330.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org While not explicitly disallowing header macro abuse (because that would make us hypocrites) lets at least address some things to think about. Signed-off-by: Alex Bennée --- docs/devel/style.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/devel/style.rst b/docs/devel/style.rst index 68aa776930..5bc6f2f095 100644 --- a/docs/devel/style.rst +++ b/docs/devel/style.rst @@ -300,6 +300,20 @@ putting those into qemu/typedefs.h instead of including the header. Cyclic inclusion is forbidden. +Generative Includes +------------------- + +QEMU makes fairly extensive use of the macro pre-processor to +instantiate multiple similar functions. While such abuse of the macro +processor isn't discouraged it can make debugging and code navigation +harder. You should consider carefully if the same effect can be +achieved by making it easy for the compiler to constant fold or using +python scripting to generate grep friendly code. + +If you do use template header files they should be named with the +``.c.inc`` or ``.h.inc`` suffix to make it clear they are being +included for expansion. + C types ======= -- 2.39.2