From: David Hunt Date: Fri, 26 Oct 2018 09:37:41 +0000 (+0100) Subject: doc: suggest to keep doc and code in same patch X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=9e0e4a00df77562b7169edf34d0218ba76fbb96b;p=dpdk.git doc: suggest to keep doc and code in same patch Add a paragraph to the patch contribution guide suggesting that developers keep doc updates in the same patch as the code, rather than one big doc update as the final patch in a patch set. Signed-off-by: David Hunt Acked-by: Ferruh Yigit --- diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index a3d7880244..ffeb50436f 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -169,6 +169,11 @@ Larger changes that require different explanations should be separated into logi A good way of thinking about whether a patch should be split is to consider whether the change could be applied without dependencies as a backport. +It is better to keep the related documentation changes in the same patch +file as the code, rather than one big documentation patch at then end of a +patchset. This makes it easier for future maintenance and development of the +code. + As a guide to how patches should be structured run ``git log`` on similar files.