From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 1875C439BA;
	Thu, 25 Jan 2024 04:39:26 +0100 (CET)
Received: from mails.dpdk.org (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id EC83342DAC;
	Thu, 25 Jan 2024 04:39:20 +0100 (CET)
Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.10])
 by mails.dpdk.org (Postfix) with ESMTP id BDB2B4027B
 for <dev@dpdk.org>; Thu, 25 Jan 2024 04:39:17 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple;
 d=intel.com; i=@intel.com; q=dns/txt; s=Intel;
 t=1706153958; x=1737689958;
 h=from:to:cc:subject:date:message-id:mime-version:
 content-transfer-encoding;
 bh=n8VRanwkbYp6cMiI2x2b4VxhTDk3BMyj6CMg+Lrs52g=;
 b=acUraN1eSGiV3DScbuW6bE/L+IZtXv5J80T7St9mXjD4EHLOsHPLEXG+
 e0Eq/9nR7Ol28J3k+tGR1PLsq8okOHshC+9hrmVJ5k9gTun9xONmHDLW3
 m/9on9pV9EGUMfWkQRG69YTy32sAY+MyMY/K+UUlHvMkDOFKJYjP13vEV
 +5Dyh17xUAS7t1kSTOimm+y/gfSyWW/424GODZ9Y2bsbMruZIJ/+Opy3Q
 Y7odXISgAeEi0YzVJDnD6eWvL21vAL+qTgLBeruWoaoMPRJpZWUBtG656
 hBz4SJsHJ9T+ZLa3sURnwVWCDAtB3ambGHSDXnQdscEGsEZwnEzX26EMJ Q==;
X-IronPort-AV: E=McAfee;i="6600,9927,10962"; a="9432937"
X-IronPort-AV: E=Sophos;i="6.05,216,1701158400"; 
   d="scan'208";a="9432937"
Received: from orviesa005.jf.intel.com ([10.64.159.145])
 by fmvoesa104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
 24 Jan 2024 19:39:05 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="6.05,216,1701158400"; 
   d="scan'208";a="2089274"
Received: from silpixa00400902.ir.intel.com ([10.243.23.146])
 by orviesa005.jf.intel.com with ESMTP; 24 Jan 2024 19:39:04 -0800
From: Sivaramakrishnan Venkat <venkatx.sivaramakrishnan@intel.com>
To: 
Cc: dev@dpdk.org, ferruh.yigit@amd.com,
 Sivaramakrishnan Venkat <venkatx.sivaramakrishnan@intel.com>
Subject: [PATCH v1] doc: update guideline for fix commit messages
Date: Thu, 25 Jan 2024 03:39:00 +0000
Message-Id: <20240125033900.1894397-1-venkatx.sivaramakrishnan@intel.com>
X-Mailer: git-send-email 2.25.1
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 <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=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 <venkatx.sivaramakrishnan@intel.com>
---
 doc/guides/contributing/patches.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index e286d9e6d5..e109365599 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -275,6 +275,12 @@ Here are some guidelines for the body of a commit message:
 
      Signed-off-by: Alex Smith <alex.smith@example.com>
 
+* .. Note::
+
+     Maintainers remove the "Cc: author@example.com" line when merging the patch.
+     To help the maintainer, the submitter may move this line to the notes section
+     of the commit, after the ``---`` separator.
+
 * When fixing an error or warning it is useful to add the error message and instructions on how to reproduce it.
 
 * Use correct capitalization, punctuation and spelling.
-- 
2.25.1