From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id B326043A3A; Thu, 1 Feb 2024 14:48:58 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9F0E342D90; Thu, 1 Feb 2024 14:48:58 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.12]) by mails.dpdk.org (Postfix) with ESMTP id F127340275 for ; Thu, 1 Feb 2024 14:48:56 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1706795337; x=1738331337; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=xGCWtIs04eadhGa77Zso8AhpndAiUZp4wp3xEsnBKyg=; b=DbVk/vIu5T82wEzcMn2szFpLWmOCqva4nzCJk7pfxc5G9TNBv/bxAv3s Syrn/P+QdIHfZd6vpnuHMpqRVrBRuY2DIxRQGa5vKrxZWSpK4yDTRtTJX lIRWVTMAkby1qhGfw1TNwHh0THeGSfl0rTSmrIv1NqfxR083mRUytDOsa orTT0RMNHwjIWCx60nmHCC466ruK1JswjgfV8PSNTcKjoZi23lggbRq9B fovlQRZ3Thu4i4ZLp1ilLn3RDM6B3KAg2xWB4L7A7z1qBTtRUnzBJtP4h qZWz1ZpSZpIxrzVjPV0K7YaEW4yQaZWTb4MzMOWQW4nIsBkeOCbodCM1l Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10969"; a="3729738" X-IronPort-AV: E=Sophos;i="6.05,234,1701158400"; d="scan'208";a="3729738" Received: from fmviesa001.fm.intel.com ([10.60.135.141]) by fmvoesa106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 01 Feb 2024 05:48:56 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.05,234,1701158400"; d="scan'208";a="30874026" Received: from silpixa00400902.ir.intel.com ([10.243.23.146]) by fmviesa001.fm.intel.com with ESMTP; 01 Feb 2024 05:48:55 -0800 From: Sivaramakrishnan Venkat To: Cc: dev@dpdk.org, ferruh.yigit@amd.com, ciara.power@intel.com, Sivaramakrishnan Venkat Subject: [PATCH v3] doc: update guideline for fix commit messages Date: Thu, 1 Feb 2024 13:48:52 +0000 Message-Id: <20240201134852.2383699-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 Content-Transfer-Encoding: 8bit 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 --- 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 | 12 ++++++++---- doc/guides/contributing/stable.rst | 3 ++- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index e286d9e6d5..4e1768025e 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 ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -336,9 +339,10 @@ In the commit message body the Cc: stable@dpdk.org should be inserted as follows Update the docs, fixing description of some parameter. Fixes: abcdefgh1234 ("doc: add some parameter") - Cc: stable@dpdk.org Signed-off-by: Alex Smith + --- + Cc: stable@dpdk.org For further information on stable contribution you can go to :doc:`Stable Contribution Guide `. diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst index 8156b72b20..bf7f4bceec 100644 --- a/doc/guides/contributing/stable.rst +++ b/doc/guides/contributing/stable.rst @@ -92,9 +92,10 @@ commit message body as follows:: Update the docs, fixing description of some parameter. Fixes: abcdefgh1234 ("doc: add some parameter") - Cc: stable@dpdk.org Signed-off-by: Alex Smith + --- + Cc: stable@dpdk.org Fixes not suitable for backport should not include the ``Cc: stable@dpdk.org`` tag. -- 2.25.1