From patchwork Wed Feb 24 11:49:26 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 386795 Delivered-To: patch@linaro.org Received: by 2002:a02:290e:0:0:0:0:0 with SMTP id p14csp307527jap; Wed, 24 Feb 2021 03:52:33 -0800 (PST) X-Google-Smtp-Source: ABdhPJwyjg/Ta+tq8RE3pru9Ygil6fGVr+pl4eqLdTvnWbVk2wgKM81lIVRkYmkfboNXtr85UMKl X-Received: by 2002:a5b:690:: with SMTP id j16mr48802293ybq.251.1614167553012; Wed, 24 Feb 2021 03:52:33 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1614167553; cv=none; d=google.com; s=arc-20160816; b=0gwmTIDGCj8+K2PkBx+wApYEqkPNBh4o1cmhfgWYSKh+dj3v/5cy4VqJRt23LojgLN KyBXf1qXx35jTQJxHYtwcZf/XZgNuNfYKltYxYT/yPZEPGh99zg79kcKQ7X4O1OcY2zq j6Ck9eVvkDY/ke+/c8bgD736JSgdNxmddZieDstCF+g1htgl3wu2/rlJsyjZxfQ2bREP /DVL//lzk9nkqu8Nn4V/QFfcFP+TTUPzAlngIQN8xpVjGWubmVr4u2u7e3UzGLErlfc1 +3YhESzVq6XgSYnIldqKvXtaEVeMaoTKbvhRjWsHKbfrD9PvbTrXezYf+5Lp3jfVyQtI YDjw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :dkim-signature; bh=Y3+FxSWPTBVmvCmaxvS+5zSnQOKO5uWtcRTHkxOmIUk=; b=p18IWzFfW52qszf+uIKwvF9IDPL5/oCzmH4ew10UW1yXOF2XYYUPlJQxH15N4/dnyJ avpJclZ8qEnzkrcIS10uCXjVnNyGKCBBXxtAxKFyxrfq0hOrQ9qjWe1ANiIqoMudJ/dY LqHM70ZyWicrwJsJ+fgWhricd9BnEZdZyH/IMQGJxp3zEhOErOLG2bcnoNEDFYiKxrn2 6xmQLY/beuwezw7acHECzAxLnMPLdHmqRg8b89xg9L9BP3M3EZsJpVsU4pEXvndT6As7 qEVDod35EpoO+wi476kQ715b4s7m8ukSwgQ4s6lKthT+hTTW8DOHoIfB8GMmm7RvAd0P Kp0A== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=L+45VmDn; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id o10si1900977ybk.317.2021.02.24.03.52.32 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Wed, 24 Feb 2021 03:52:33 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=L+45VmDn; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:35750 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lEsiW-0000GY-EL for patch@linaro.org; Wed, 24 Feb 2021 06:52:32 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:56180) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lEsfj-0005yt-Ne for qemu-devel@nongnu.org; Wed, 24 Feb 2021 06:49:39 -0500 Received: from mail-wm1-x332.google.com ([2a00:1450:4864:20::332]:54752) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lEsfh-0002WA-Sd for qemu-devel@nongnu.org; Wed, 24 Feb 2021 06:49:39 -0500 Received: by mail-wm1-x332.google.com with SMTP id v21so1535416wml.4 for ; Wed, 24 Feb 2021 03:49:37 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Y3+FxSWPTBVmvCmaxvS+5zSnQOKO5uWtcRTHkxOmIUk=; b=L+45VmDnMDz80wfoAUg5qOiyhHP0ELQA8awrLLft66s9TE87zY278qxvxQDgo3qc+r g2WdI18VKAdgZ9t6DvKtMqjkvLIBybXyZvnZ5xJY5j7eH+Lfr98TTst4znsF2t10nvkh s9zny0+qV54cUDz6/6Thu2LEdSskEvrx52ffn4tQOik5RpryTri1zRy//PXi9iRB1YEE Tp1xusCSiossnJ13vtnK6inXBfjkPCfXExzEdyakhYCmMs0f3yBO/fVs1h5Go7abuLjY ARr7Zc8KkBnLdFYHZLp+ay4qv1f/j311cm6nUD5zaGFOdJvvnoLaY7aPLCw3BRsaPkda gSqQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Y3+FxSWPTBVmvCmaxvS+5zSnQOKO5uWtcRTHkxOmIUk=; b=Wbhvkju74GhphfrCIub2r0OdYL03762JlogpB7Jfa7CLqtA+ybbOOunFfezeQ5W+5J 139uE63eITyyKOf4XsjmybUqgika4a7etf9wpfgiKLh30CYY4BYkDPmxukj2ByNi9Cwi obN/JtGrRPynQcFf+qUDmQDPXuceYt7HNB9yUXW5/AYt040VD8Q8TZDSHdoEdNWC2RRw +a+r2rKF3WL9iRCyBuNIm4P3cRUPv8MW7KRiBiV8AE73LDccnm8/J/eikhnQysIz5KIG 4taly7yfblbRMOlL9vKbgrJcDVKDtmXrnvsJw1KCsACMgwpyN6SYEwtT5SrDUL8XYcXX jWeQ== X-Gm-Message-State: AOAM533BT1DPJi6gr4DK2GxqtFyi4vb3aGaUTFwoowN7L1z4ZHtBiQ0L 7eqQzdUWAbhjOkAQiNFYpE5BA+rqqGAwEA== X-Received: by 2002:a05:600c:2149:: with SMTP id v9mr1669798wml.102.1614167376721; Wed, 24 Feb 2021 03:49:36 -0800 (PST) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id z18sm3056063wrs.19.2021.02.24.03.49.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 24 Feb 2021 03:49:32 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 0F68B1FF93; Wed, 24 Feb 2021 11:49:27 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: peter.maydell@linaro.org Subject: [PULL 7/7] docs: move CODING_STYLE into the developer documentation Date: Wed, 24 Feb 2021 11:49:26 +0000 Message-Id: <20210224114926.6303-8-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210224114926.6303-1-alex.bennee@linaro.org> References: <20210224114926.6303-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::332; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x332.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 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?utf-8?q?Alex_Benn=C3=A9e?= , qemu-devel@nongnu.org, Claudio Fontana Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" There is no particular reason to keep this on it's own in the root of the tree. Move it into the rest of the fine developer manual and fixup any links to it. The only tweak I've made is to fix the code-block annotations to mention the language C. Signed-off-by: Alex Bennée Reviewed-by: Claudio Fontana Message-Id: <20210223095931.16908-1-alex.bennee@linaro.org> -- 2.20.1 diff --git a/docs/devel/index.rst b/docs/devel/index.rst index 22854e334d..ae664da00c 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -14,6 +14,7 @@ Contents: :maxdepth: 2 build-system + style kconfig testing fuzzing diff --git a/CODING_STYLE.rst b/docs/devel/style.rst similarity index 99% rename from CODING_STYLE.rst rename to docs/devel/style.rst index 7bf4e39d48..8b0bdb3570 100644 --- a/CODING_STYLE.rst +++ b/docs/devel/style.rst @@ -641,7 +641,7 @@ trace-events style In trace-events files, use a '0x' prefix to specify hex numbers, as in: -.. code-block:: +.. code-block:: c some_trace(unsigned x, uint64_t y) "x 0x%x y 0x" PRIx64 @@ -649,14 +649,14 @@ An exception is made for groups of numbers that are hexadecimal by convention and separated by the symbols '.', '/', ':', or ' ' (such as PCI bus id): -.. code-block:: +.. code-block:: c another_trace(int cssid, int ssid, int dev_num) "bus id: %x.%x.%04x" However, you can use '0x' for such groups if you want. Anyway, be sure that it is obvious that numbers are in hex, ex.: -.. code-block:: +.. code-block:: c data_dump(uint8_t c1, uint8_t c2, uint8_t c3) "bytes (in hex): %02x %02x %02x" diff --git a/README.rst b/README.rst index ce39d89077..91aa1e314c 100644 --- a/README.rst +++ b/README.rst @@ -66,7 +66,9 @@ When submitting patches, one common approach is to use 'git format-patch' and/or 'git send-email' to format & send the mail to the qemu-devel@nongnu.org mailing list. All patches submitted must contain a 'Signed-off-by' line from the author. Patches should follow the -guidelines set out in the CODING_STYLE.rst file. +guidelines set out in the `style section +` of +the Developers Guide. Additional information on submitting patches can be found online via the QEMU website diff --git a/scripts/fix-multiline-comments.sh b/scripts/fix-multiline-comments.sh index 93f9b10669..c15a041272 100755 --- a/scripts/fix-multiline-comments.sh +++ b/scripts/fix-multiline-comments.sh @@ -1,6 +1,6 @@ #! /bin/sh # -# Fix multiline comments to match CODING_STYLE +# Fix multiline comments to match docs/devel/style.rst # # Copyright (C) 2018 Red Hat, Inc. #