doc/contrib: patch and code in same file
Checks
Commit Message
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>
---
doc/guides/contributing/patches.rst | 5 +++++
1 file changed, 5 insertions(+)
Comments
On 10/26/2018 10:37 AM, David Hunt wrote:
> 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>
26/10/2018 13:37, Ferruh Yigit:
> On 10/26/2018 10:37 AM, David Hunt wrote:
> > 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>
Applied with following title:
doc: suggest to keep doc and code in same patch
@@ -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.