From patchwork Tue Nov 21 19:59:05 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ferruh Yigit X-Patchwork-Id: 31502 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 001F7101B; Tue, 21 Nov 2017 20:59:14 +0100 (CET) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 98226F94; Tue, 21 Nov 2017 20:59:13 +0100 (CET) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 21 Nov 2017 11:59:09 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos; i="5.44,432,1505804400"; d="scan'208"; a="1246964620" Received: from silpixa00372839.ir.intel.com (HELO silpixa00372839.ger.corp.intel.com) ([10.237.222.154]) by fmsmga002.fm.intel.com with ESMTP; 21 Nov 2017 11:59:07 -0800 From: Ferruh Yigit To: Thomas Monjalon , John McNamara Cc: dev@dpdk.org, Ferruh Yigit , techboard@dpdk.org Date: Tue, 21 Nov 2017 19:59:05 +0000 Message-Id: <20171121195905.66410-1-ferruh.yigit@intel.com> X-Mailer: git-send-email 2.13.6 Subject: [dpdk-dev] [PATCH] doc: update contribution guideline for dependent work X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Changing some part of the libraries but not updating all dependent code cause maintenance problems. The update in the contribution guide practically suggest updating all dependent code. With the counter argument that sometimes it is not possible to know details of the dependent code and this prevents improvements, an exception left for the cases dependent code requires special expertise, for those cases it is possible left dependent code unchanged with the condition to not break the existing code. The dependent code maintainer should do the required update later. For the cases it is possible to update the dependent code but it requires extra work, it is expected from author of the original patch to do that extra work and update dependencies. Signed-off-by: Ferruh Yigit Acked-by: John McNamara --- This is a process related update, cc'ing tech board for more comment. Cc: techboard@dpdk.org --- doc/guides/contributing/patches.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 40983c150..7effe3fa5 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -130,6 +130,9 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * Don't break compilation between commits with forward dependencies in a patchset. Each commit should compile on its own to allow for ``git bisect`` and continuous integration testing. +* If changes effect other parts of the project, update all those parts as well unless updating requires special knowledge. + For the cases not all effected code updated, ensure that changes don't break existing code. + * Add tests to the the ``app/test`` unit test framework where possible. * Add documentation, if relevant, in the form of Doxygen comments or a User Guide in RST format.