d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: suggest to keep doc and code in same patch

Browse Source 
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 <david.hunt@intel.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
This commit is contained in:
David Hunt 2018-10-26 10:37:41 +01:00 committed by Thomas Monjalon
parent 904ffb2e96
commit 9e0e4a00df
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/guides/contributing/patches.rst
View File

@ -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.