DPDK patches and discussions
 help / color / mirror / Atom feed
From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>,
	John McNamara <john.mcnamara@intel.com>,
	Marko Kovacevic <marko.kovacevic@intel.com>
Cc: dev@dpdk.org, techboard@dpdk.org
Subject: [dpdk-dev] [PATCH v2] doc: update contribution guideline for dependent work
Date: Tue,  9 Jan 2018 15:44:02 +0000	[thread overview]
Message-ID: <20180109154402.85731-1-ferruh.yigit@intel.com> (raw)
In-Reply-To: <20171121195905.66410-1-ferruh.yigit@intel.com>

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 <ferruh.yigit@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>

---
This is a process related update, cc'ing tech board for more comment.
Cc: techboard@dpdk.org

v2: reworded as suggested.
---
 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 64408e788..6ed43be04 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -153,6 +153,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 where not all the effected code is updated, the submitter should 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.
-- 
2.14.3

  parent reply	other threads:[~2018-01-09 15:44 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-21 19:59 [dpdk-dev] [PATCH] " Ferruh Yigit
2017-12-11 14:26 ` Mcnamara, John
2017-12-12 15:54   ` [dpdk-dev] [dpdk-techboard] " Olivier MATZ
2017-12-12 18:57     ` Ferruh Yigit
2017-12-13  8:55       ` Olivier MATZ
2018-01-09 15:44 ` Ferruh Yigit [this message]
2018-05-24 16:58   ` [dpdk-dev] [PATCH v2] " Thomas Monjalon
2019-04-05 15:00     ` Ferruh Yigit
2019-04-05 15:00       ` Ferruh Yigit
2019-04-05 15:02       ` [dpdk-dev] [dpdk-techboard] " Ferruh Yigit
2019-04-05 15:02         ` Ferruh Yigit

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180109154402.85731-1-ferruh.yigit@intel.com \
    --to=ferruh.yigit@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=marko.kovacevic@intel.com \
    --cc=techboard@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).