From patchwork Tue Jan 30 14:09:24 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sivaramakrishnan Venkat X-Patchwork-Id: 136221 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 68EE443A0E; Tue, 30 Jan 2024 15:10:10 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id F2AEF402CE; Tue, 30 Jan 2024 15:10:09 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.10]) by mails.dpdk.org (Postfix) with ESMTP id 7C755402CD for ; Tue, 30 Jan 2024 15:10:07 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1706623807; x=1738159807; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=x7NGU6vJsngCP1f8j4B02NAQBjAPgpkJkEUuBKYHZQk=; b=RfyCIiMAYrr+iPymjxjWCpVkdE/kvc+1S7F0sgSPrBXfqc3NeZFBjFO0 vQEcyM5cYR1PWe9MfRGjxmC024xsfs2CCjyNSUvq0sdMksSTRtEKP70nh vwBJSoP4tv5DNGnGsKClCW0OS5q3vrzGZrf2aOls+Hw29rUO/XXJsqdD/ 8HQRfn1x+aR+YFeWquUgandkEcl5UbL38StbTt5gEdgnBBUUSx8kiVe8+ l8sKB1Kc5ueUGOKlVomsgqzBEJQb0ZJJccfy7xoZwgSU4Gnoj0gOyW9/M f1b0Vy9aTQ5XScXnKNNRs/03OWo5B32FLNdIDIAzyu8g8WfWHh72FQOGT A==; X-IronPort-AV: E=McAfee;i="6600,9927,10968"; a="10679008" X-IronPort-AV: E=Sophos;i="6.05,707,1701158400"; d="scan'208";a="10679008" Received: from fmviesa005.fm.intel.com ([10.60.135.145]) by fmvoesa104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 30 Jan 2024 06:09:28 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.05,707,1701158400"; d="scan'208";a="3699004" Received: from silpixa00400902.ir.intel.com ([10.243.23.146]) by fmviesa005.fm.intel.com with ESMTP; 30 Jan 2024 06:09:27 -0800 From: Sivaramakrishnan Venkat To: Cc: dev@dpdk.org, ferruh.yigit@amd.com, ciara.power@intel.com, Sivaramakrishnan Venkat Subject: [PATCH v2] doc: update guideline for fix commit messages Date: Tue, 30 Jan 2024 14:09:24 +0000 Message-Id: <20240130140925.2045961-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 --- v2: - Samples updated to the desired format for the "Cc:" line in the commit message --- doc/guides/contributing/patches.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index e286d9e6d5..5687b5fa27 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.