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 16AC3439C1; Thu, 25 Jan 2024 12:24:32 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8943E402AB; Thu, 25 Jan 2024 12:24:31 +0100 (CET) Received: from NAM10-BN7-obe.outbound.protection.outlook.com (mail-bn7nam10on2044.outbound.protection.outlook.com [40.107.92.44]) by mails.dpdk.org (Postfix) with ESMTP id 6D0644029B for ; Thu, 25 Jan 2024 12:24:29 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Jog/WYrIb7jGe1h2suPnG9NFM+ydZyWrMVxkiFEhVH5lGq+CWj4wLbG2QnM0YaNBHafM61G89BIfO7YHvxyau+euijTMkaO+GjMWXnYpwY87r8JNzomGQwY92MCVnOoT8ijJ4nnZAWBZ3Igjfmalwld9/gTdV9nNzjPzkno1H9Iiza2TPBbpsM4FeA+3hIcR1wrXnscSVH8YXA5+wv3umvPN3qpIqpVWln/IJr6FeHF+oow0ud0dC1W6vcGxCWVrzg6q8vF8SPq+7dM9W7qy3SD5KufXeB1vgfVmP2DPIGLUG7o2QE8W55g6ghMCPYTG/+hRPg5aKZ9VTlqsX2Hyiw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=kFzKrROrr6MtnA8wiR5zPYFC0LENSfuwxJQN18jhEeg=; b=QLSeftzFSj6l47LhL6Ca93iUvCiUt21pQajlNpMc5hKJ5UwODV2M3zJjvJfDQ/XJizyizqJMvVXFd4h+DI9s/Pv5CT96RowjaInBNzTYA4whRtdG88u5X7YNWGil1k99lgZBHs4sdjVMyvcD9MByNV63g/hDlNInKs17tNErsj/98TxwgSnrx9sXg/E42MiF1AIYuxcjiXz2MCB0UIjVfGd6S+52OznSMusP/tr+BiClWgNsl7OyZnYSQhF8xmD8atSvXyNm9Abu7E18O+bdM4UbEec/cjOCsADm5xnKSxy/hhwVat8swRaY+BD/LZsA0h/mi0FmkVXIDWoxaxiNuw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=amd.com; dmarc=pass action=none header.from=amd.com; dkim=pass header.d=amd.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=kFzKrROrr6MtnA8wiR5zPYFC0LENSfuwxJQN18jhEeg=; b=eTvlQ2X2H7c2BgC7dYFZJBMrHLRtbfSoNCt0ykcQ6MIPGdkpz34H4AQ2JeLBuK0E9jS2hQME+7k3/NOXPDxyGIC5/h7kJwyo2Ac+A+GW+b7AAjQ3zJYQjEpzwFtTyvfotVPoKKs2zcIYArKg0HhHKGNQjLUaDX1t/avzG3Lfuz4= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=amd.com; Received: from CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) by CH0PR12MB5076.namprd12.prod.outlook.com (2603:10b6:610:e3::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7228.26; Thu, 25 Jan 2024 11:24:27 +0000 Received: from CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::815a:45e6:cf5e:479f]) by CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::815a:45e6:cf5e:479f%4]) with mapi id 15.20.7228.022; Thu, 25 Jan 2024 11:24:27 +0000 Message-ID: Date: Thu, 25 Jan 2024 11:24:24 +0000 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v1] doc: update guideline for fix commit messages Content-Language: en-US To: Sivaramakrishnan Venkat Cc: dev@dpdk.org References: <20240125033900.1894397-1-venkatx.sivaramakrishnan@intel.com> From: Ferruh Yigit Autocrypt: addr=ferruh.yigit@amd.com; keydata= xsFNBGJDD3EBEAC/M7Tk/DfQSmP1K96vyzdhfSBzlCaGtcxNXorq4fALruqVsD3oi0yfyEz9 4YN8x7py0o9EL8ZdpOX0skc0AMCDAaw033uWhCn0GLMeGRKUbfOAPvL6ecSDvGD7CJIO9j0J eZUvasBgPdM/435PEr9DmC6Ggzdzt8IuG4PoLi5jpFSfcqxZFCCxLUDEo/w0nuguk2FTuYJg B2zEZ4JTBZrw7hIHiFh8D8hr6YA6a5uTofq1tr+l048lbtdFUl8TR0aIExVzE4Z8qKZlcE+9 RQaewjK5Al1jLE4sHdmd3GN+IvgDF3D/fLsi25SKJDeGSdeHkOmaX0qGeM4WKIfU6iARRCiQ N3AmBIxZ/A7UXBKLaOyZ+/i3sE6Wb53nrO4i8+0K2Qwyh6LjTeiJAIjYKN43ppxz3DaI+QwQ vI+uyHr4Gg0Da9EPPz/YyKauSeOZCfCB5gIfICO0j6x0SCl8uQ2nLpjxcZkf0gjcwUzP3h+S 3x6NfDji9YEij0zczW/dcSpGgZ6vsFpPrtnP9ZXy6J53yp0kJtOJoOlkEFFdU2yCZnCDseum CoudmGLZVvS0/DzHDJejq+3kK3FDGktZBOxZIIpal+nFqS7lVgOZc4+huVv3jyhzoAUOEyXA XK5j6o7g8STUY+z33QNnHpdLvecMwuzmvqy0jR54yAbZ64mB9QARAQABzSNGZXJydWggWWln aXQgPGZlcnJ1aC55aWdpdEBhbWQuY29tPsLBlwQTAQgAQQIbAwULCQgHAgYVCgkICwIEFgID AQIeAQIXgAIZARYhBEm7aYjps5XGsPHCElRTPtCKKm/6BQJkdyEEBQkE3meNAAoJEFRTPtCK Km/6UdcP/0/kEp49aIUhkRnQfmKmNVpcBEs4NqceNCWTQlaXdEwL1lxf1L49dsF5Jz1yvWi3 tMtq0Mk1o68mQ7q8iZAzIeLxGQAlievMNE0BzLWPFmuX+ac98ITBqKdnUAn6ig5ezR+jxrAU 58utUszDl16eMabtCu76sINL5izB8zCWcDEUB4UqM8iBSQZ7/a7TSBVS0jVBldAORg1qfFIs cGMPQn/skhy3QqbK3u3Rhc44zRxvzrQJmhY6T1rpeniHSyGOeIYqjpbpnMU5n1VWzQ4NXvAD VDkZ4NDw6CpvF4S2h2Ds7w7GKvT6RRTddrl672IaLcaWRiqBNCPm+eKh4q5/XkOXTgUqYBVg Ors8uS9EbQC/SAcp9VHF9fB+3nadxZm4CLPe5ZDJnSmgu/ea7xjWQYR8ouo2THxqNZtkercc GOxGFxIaLcJIR/XChh9d0LKgc1FfVARTMW8UrPgINVEmVSFmAVSgVfsWIV+NSpG9/e90E4SV gMLPABn1YpJ8ca/IwqovctqDDXfxZOvCPOVWTzQe/ut767W+ctGR1kRkxWcz470SycOcY+PW VRPJd91Af0GdLFkwzZgNzkd6Gyc9XXcv4lwwqBLhWrBhqPYB0aZXIG1E/cVTiRp4dWpFHAFD DcuLldjIw93lCDsIeEDM9rBizGVMWEoeFmqSe7pzGTPXzsFNBGJDD3EBEAC8fBFQHej8qgIG CBzoIEd1cZgPIARlIhRudODXoNDbwA+zJMKtOVwol3Hh1qJ2/yZP11nZsqrP4fyUvMxrwhDe WBWFVDbWHLnqXMnKuUU1vQMujbzgq/4Rb9wSMW5vBL6YxhZng+h71JgS/9nVtzyaTtsOTrJi 6nzFSDx6Wbza2jYvL9rlK0yxJcMEiKwZQ/if4KcOesD0rtxomU/iSEv6DATcJbGXP6T93nPl 90XksijRKAmOwvdu3A8IIlxiSSVRP0lxiHOeR35y6PjHY2usfEDZZOVOfDfhlCVAIBZUZALv VmFOVSTYXeKgYa6Ooaf72+cHM3SgJIbYnevJfFv8YQW0MEAJ/IXE7B1Lk+pHNxwU3VBCrKnA fd/PTvviesuYRkrRD6qqZnINeu3b2DouVGGt2fVcGA38BujCd3p8i7azoGc7A6cgF7z9ETnr ANrbg1/dJyDmkDxOxVrVquTBbxJbDy2HaIe9wyJTEK2Sznpy62DaHVY+gfDQzexBXM10geHC IIUhEnOUYVaq65X3ZDjyAQnNDBQ4uMqSHZk8DpJ22X+T+IMzWzWl+VyU4UZXjkLKPvlqPjJk 1RbKScek5L2GhxHQbPaD76Hx4Jiel0vm2G+4wei8Ay1+0YRFkhySxogU/uQVXHTv63KzQMak oIfnN/V2R0ucarsvMBW+gwARAQABwsF8BBgBCAAmAhsMFiEESbtpiOmzlcaw8cISVFM+0Ioq b/oFAmR3IPsFCQTeZ44ACgkQVFM+0Ioqb/qINhAAtcor9bevHy22HvJvXX17IOpPSklZJAeQ Az43ZEo5kRlJ8mElc2g3RzYCvL/V3fSiIATxIsLq/MDtYhO8AAvklxND/u2zeBd7BkRZTZZX W1V1cM3oTvfx3LOhDu4f2ExQzCGdkzbXTRswSJIe1W0qwsDp+YPekbrsKp1maZArGeu+6FuW honeosIrWS98QJmscEhP8ooyJkLDCCOgEk+mJ/JBjzcJGuYn6+Iy/ApMw/vqiLGL1UWekcTA g18mREHqIR+A3ZvypIufSFB52oIs1zD/uh/MgmL62bY/Cw6M2SxiVxLRsav9TNkF6ZaNQCgn GqifliCEMvEuLZRBOZSYH2A/PfwjYW0Ss0Gyfywmb2IA990gcQsXxuCLG7pAbWaeYazoYYEQ NYmWatZNMAs68ERI2zvrVxdJ/fBWAllIEd0uQ4P05GtAHPdTIDQYp545+TPV7oyF0LfXcsQs SFVZE6igdvkjfYmh+QOrHGZvpWXLTmffVf/AQ81wspzbfxJ7sYM4P8Mg5kKOsaoUdyA/2qVe cMh1CLUHXF1GlofpGbe1lj4KUJVse5g3qwV7i9VrseA8c4VIZewdIjkzAhmmbxl+8rM/LKBH dZUMTzME5PFCXJIZ83qkZQ795MTe2YScp9dIV7fsS5tpDwIs7BZNVM1l3NAdK+DLHqNxKuyO 8Zk= In-Reply-To: <20240125033900.1894397-1-venkatx.sivaramakrishnan@intel.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-ClientProxiedBy: LO6P265CA0005.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:339::13) To CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH2PR12MB4294:EE_|CH0PR12MB5076:EE_ X-MS-Office365-Filtering-Correlation-Id: 9a55dfd0-69a5-491d-9581-08dc1d9830f6 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: tg12S8azxpyOBL+xbjgrnFXMHXD0Kma7ISUITEHHmEIVL9lORNxKDUbvPurn46d88SebLRbAumXRNMMM9wIRHUdVUIwy9e5H3c0Zkn6njZSkMeWu3JZViyWXdSMMjc0LbLCqPPNWRTnDrw5l3/vJReaRZOdOjz24P6323Q0qDV10KOEkFYE3I2Z9ofQQWl3MF4UyiPnJ0gLbmc3Ltv7NIBJ6BPovXn3NmCaz3IfzwFWZEedhlRo4+VchgDFLzIKPyBVcBv2x+vRGV4CK+896ljOrekKmbhQxpAUuCUyQ7G8rkpJHNhJhW7v4QZyjzaGCJUJ9vBL/2sFH3dbBb3aLfnDm8Jt8J3y6Hs3LSNLdJgcQCOuXUAjiQXiFS8agp5hOZlO6Cur2jPVxR89ZgMhZsoaQXF4Dazu9KTvUwwt43NtcRwdYz1VWG+kdZEnRCPsXZBBSW5pJN8T+faXE9nHRt4/m8YW4s6fAFidm3EUd2ViuSrWM0qVpqMzlFjkcXal5JiErw5X+Y6rUmHbB6oxiWBFfhPYGKj5PvDLeocJ0zR5MpsyPHAom4KwEbkq+iMdKlOW+M0aw9xfbJce0GK+yMHxPpENeoql6gdED480CARtWDFOWyNJByeDpVIleafmjyRS3Wwz0hsJ/LWQ5iTIXH2MP2ZPno1bkh/DF336TjFdZ7mZOuIiLKSJBQk5KsIOl X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:CH2PR12MB4294.namprd12.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031)(366004)(346002)(376002)(136003)(39860400002)(396003)(230273577357003)(230173577357003)(230922051799003)(1800799012)(186009)(64100799003)(451199024)(83380400001)(2616005)(53546011)(26005)(38100700002)(4326008)(5660300002)(15650500001)(8936002)(8676002)(44832011)(41300700001)(2906002)(6486002)(478600001)(6506007)(6512007)(6666004)(66556008)(6916009)(66946007)(66476007)(316002)(36756003)(86362001)(31696002)(31686004)(45980500001)(43740500002); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?NEZIRzRuc0J4ZThqbnlGamE2MW1wRVMrK2tQY0dDZndGRFBmUGU5cWd2Wnkx?= =?utf-8?B?TGg0eFdSYnp6MUdPOVBzeTU2bmZyOGJLVEtnQUlVa0ZpUElkMnVsWUJoYnVh?= =?utf-8?B?c2tPTUlYVjI4OUhTR3dGY3NPTHI1YWYrTWk4ZzRaU1ZFQlFQYTZReXppU3VM?= =?utf-8?B?S0dkZGNGTjgxc1owbHJiMU1lcWpqdDBiVjIyOXFlU0VlK1Y4aU5sT0xLYXVG?= =?utf-8?B?cGUyWXJTc2RYQ3VSZXQ5T3VCeXg4S2VNYzY2Qmxsc0lYaWpYTTZVeUNRUmNx?= =?utf-8?B?OVlreFVsUXNLaWNCMERaZ0ZNZE1Ma3U1WjJPY3lCMkZ2MXFUdWJOMEZEeGFG?= =?utf-8?B?WDRYRVhKeFpUY0YycGVYelNRVEliOEo0U2dMcWZqTnduZ0NwcXd1R2x3WHF0?= =?utf-8?B?eFEwdW02VGIzMzBPQXNCSDh3NHY4bEFBWTNpQXNQMkh1TThmSS83VGJ2U3BP?= =?utf-8?B?bU11M3lCQ1E3THhSUldLWkptMHJZYTFTMDludXFmV1oyT1hYckdOeW9IWGxE?= =?utf-8?B?ZHZXRXY4blJyWlFSenczZFQya0V5dFVXOFlrNmIvQTJicm50N0g1dDc5Wnds?= =?utf-8?B?ZDBmQ1NURjh3cERwV3JBQVRjYTFKRkpYUUJjMXdOaG8vMWgreVZjdFE3Wkpi?= =?utf-8?B?MGN5aG82KzdOeUZuUVVCclo2MWoxbXJHZVhrS2c2UEordEJLR3VSTW9ITnpN?= =?utf-8?B?a0t5L1VLdExCU1FNZU9IS2dqTnI3cFJ5VTh6NThnajBwMlMyaEdYUlVnckZR?= =?utf-8?B?dVlNVXp4RmtnMTBEWXE4Vis5TFF6K2JwZ2ZyOUJ1M1Q0NHcxNjYzbnQ5Wkwy?= =?utf-8?B?dGNpWDRmK2xPcDFpVHBld0NPMVlRdUJnREJmQmtFOVlLMk1MNGJuVThBQTda?= =?utf-8?B?TFpqeTVCek1QS0lJOVJHanU2ajNQOERsUVl0ODFDTzJ4b0prTk56cE9Rcllx?= =?utf-8?B?MnBMc011RkZadUQ0RzFKOEFHdldGdW9idU56ZWlUekU1WTUrTnhVcVFWeXVW?= =?utf-8?B?RWQxbWw2MHcvL09JNVNHQnRhRHhhSzkxbzZJeHhYUXZWbDV5VU80WDBIR2xp?= =?utf-8?B?U0FHQ0xLNzZOQXQzUnNlOWptV2ljUVRYcGtqekthRSswWk1ZSCtJZDlaU2E1?= =?utf-8?B?YkZVaHc1V0VaZ0lSYndoU2dSRUZXekd2OHpQdzA4TVNXZUUxQzM1SUpUSG9H?= =?utf-8?B?dGpPakt4RzBpTDhzbU9tc1I1N2hiU1R1V0syOE02RGFhbkduYVZXU3MxYmpT?= =?utf-8?B?WXowWGtBc3FJNnNSWHRpSEdpYk1HNjNnckdpUjRwdU9CZS9VOFJVdFdNUWla?= =?utf-8?B?eFNyTTM5Umpld1lhMEdnS2F2ZC9Ra3Izci9rSlpDbnJtcHN6RytCY29qOGFY?= =?utf-8?B?SEJ0MTFyY2Q5NDJPSlpFY3Q2SkQ4QnhEVGpINXJFTDg0dkYwR2RhNnNqbFd4?= =?utf-8?B?T2xZL29VcWpGajV4VUJKTGJuT241QTg0ZFNNMTk0alFBVUxLMGN5bU9qcGMx?= =?utf-8?B?eS9mRGJkYzV2VTJZVUo5d2dnWWRBTzl2ZncvNU1pb0NrUHp3SFF5TjdkNUUw?= =?utf-8?B?ZFJLMlpoRU5ZM2hoejBFRGQvUmhkNzMwU1R6OVpiNkJoM0xNWWd2dkJPbUZN?= =?utf-8?B?STU3d2cvNitVWm01OVFoUDAxVXJuV0o0S1dxZmNSZ0sxeVVGNXJnc1Q2dFNl?= =?utf-8?B?TXppTWxBdk5GbTlQak11OFBkLzlmdHY4d1BRbG9lMUtLdDUxREF1aTM5SWp6?= =?utf-8?B?am5nMURnRjNIZHNZTGs2YjBnWnkzUTFXSzU2WFRLZTZOSGxhRWVsa2VNWHdl?= =?utf-8?B?ZmdUNGtJZ2E3amtjVGpWUGFibXJULy95aDJxUUtpejFvTysvak0wQzZCeWw1?= =?utf-8?B?bGhiNmhqT2NpcnE4SzBIdmpoOTkrbVJTWTR0SktucTBXUjM4ZUJua3AxOXRD?= =?utf-8?B?ak5IdHFDV3RXbGhPbW9PUWRGV1BPWnpodUhGNlhJK0paaTA5cUdxL3VjWU5s?= =?utf-8?B?MDdYZ2VaN2RieG9uWTJoTlVQTHF0ZWw5cUw4OHRGa2l4VVlNRXMxR2t3NEkr?= =?utf-8?B?RzJOSTNvbGF0NWxVOU5IdkFHUDVpSElubnVSanFLcVg5NWJhR3JBUXZCR1Uz?= =?utf-8?Q?C5bxntiEoid1GFNpgw0YTqsg/?= X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-Network-Message-Id: 9a55dfd0-69a5-491d-9581-08dc1d9830f6 X-MS-Exchange-CrossTenant-AuthSource: CH2PR12MB4294.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Jan 2024 11:24:27.5118 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: e2dKSlSfyv9/+CJqVF+aR3h+nFUYGRLr+QxtuCuGALK23JwFj9wsNxnzj7RHQVm5 X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH0PR12MB5076 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 On 1/25/2024 3:39 AM, Sivaramakrishnan Venkat wrote: > 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 > --- > 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 > > +* .. 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. Thanks Sivaramakrishnan for the doc update, that is practically what happens, but "Note" is to get additional attention, and there are already multiple steps involved to prepare a commit log and this one is not really that important, so lets not complicate it more for new contributors. One option is add above information without ".. Note::" block, and shorten it a little more, with adding the reasoning of adding "Cc: author@example.com" (so I am asking adding more info and make paragraph shorter :) Other option is update samples to the desired format, it won't explain the ask but imply it by showing requested output, as we are doing for "Depends-on" tag. I am for starting with the second option first, update samples, and see if it improves things, what do you think?