doc/contrib: patch and code in same file
PATCH 1/1 doc/contrib: patch and code in same file
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 <[email protected]>
--- doc/guides/contributing/patches.rst | 5 +++++ 1 file changed, 5 insertions(+)
doc/guides/contributing/patches.rst +5 -0
@@ -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.
Signature · 1 line
2.17.1
Quoted 5 lines · David Hunt
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 <[email protected]>
Acked-by Ferruh Yigit <[email protected]>
26/10/2018 13:37, Ferruh Yigit:
Quoted 8 lines · David Hunt
Quoted 5 lines
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 <[email protected]>Acked-by Ferruh Yigit <[email protected]>
Applied with following title:
doc: suggest to keep doc and code in same patch