From patchwork Thu Feb 8 10:51:13 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sivaramakrishnan Venkat X-Patchwork-Id: 136533 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E964643AD7; Thu, 8 Feb 2024 11:51:19 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D5D334028B; Thu, 8 Feb 2024 11:51:19 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.9]) by mails.dpdk.org (Postfix) with ESMTP id 9FCB340278 for ; Thu, 8 Feb 2024 11:51:18 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1707389479; x=1738925479; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=d62jOQG4fek0SrDVRh1eJg1TmUddfcKNjA7mEJqUkQY=; b=n25FLaHHBStcYtORxn2WVB6CctjglKKXAVWEGWq+F+Z1t8vm0nxcnanr U3LPs/r/dYuLzw7QRCuubnJlWOhrI4TMfykXpLzHaNSaOPlv7cfW55xmH dnzmvHBtF91o4p2hfrg1f7G27XgQlu0OA/H5kyXHQzh6SwSLNWPYC/EGL oO/J74maO7QyIMZupY8YXIlwWwxast3EUgshHsdh7vPPlOnERq9FJ6A+g GU4VFSrCBpf5fxeGyYTgJfAP0BiAcf94zEO5YpGanabUZqzgPU3fSPojT hzN/LWxol1Ox8H0JB3Je8BZG4Ziph6RsntaFzqxquHjnm8gGNdcd+80QB w==; X-IronPort-AV: E=McAfee;i="6600,9927,10977"; a="23672309" X-IronPort-AV: E=Sophos;i="6.05,253,1701158400"; d="scan'208";a="23672309" Received: from fmviesa002.fm.intel.com ([10.60.135.142]) by orvoesa101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 08 Feb 2024 02:51:18 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.05,253,1701158400"; d="scan'208";a="24868549" Received: from silpixa00400902.ir.intel.com ([10.243.23.146]) by fmviesa002.fm.intel.com with ESMTP; 08 Feb 2024 02:51:16 -0800 From: Sivaramakrishnan Venkat To: Cc: dev@dpdk.org, ciara.power@intel.com, ferruh.yigit@amd.com, Sivaramakrishnan Venkat Subject: [PATCH v4] doc: update guideline for fix commit messages Date: Thu, 8 Feb 2024 10:51:13 +0000 Message-Id: <20240208105113.2458550-1-venkatx.sivaramakrishnan@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20240125033900.1894397-1-venkatx.sivaramakrishnan@intel.com> References: <20240125033900.1894397-1-venkatx.sivaramakrishnan@intel.com> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Maintainers remove the Cc author line when merging the patch. So, the guidelines is updated with a suggestion for the placement of Cc lines in a commit message for easy merging. Signed-off-by: Sivaramakrishnan Venkat Acked-by: Ferruh Yigit Acked-by: Ciara Power --- v4: - Reverted removal of "Cc: stable@dpdk.org" in the commit log v3: - Other samples updated to the desired format for the "Cc:" line in the commit message v2: - Samples updated to the desired format for the "Cc:" line in the commit message --- doc/guides/contributing/patches.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index e286d9e6d5..7605ea4d64 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -271,9 +271,10 @@ Here are some guidelines for the body of a commit message: Update the docs, fixing description of some parameter. Fixes: abcdefgh1234 ("doc: add some parameter") - Cc: author@example.com Signed-off-by: Alex Smith + --- + Cc: author@example.com * When fixing an error or warning it is useful to add the error message and instructions on how to reproduce it. @@ -300,9 +301,10 @@ in the body of the commit message. For example:: Coverity issue: 12345 Fixes: abcdefgh1234 ("doc: add some parameter") - Cc: author@example.com Signed-off-by: Alex Smith + --- + Cc: author@example.com `Bugzilla `_ @@ -319,9 +321,10 @@ For example:: Bugzilla ID: 12345 Fixes: abcdefgh1234 ("doc: add some parameter") - Cc: author@example.com Signed-off-by: Alex Smith + --- + Cc: author@example.com Patch for Stable Releases ~~~~~~~~~~~~~~~~~~~~~~~~~