* [dpdk-dev] [PATCH] doc/contrib: patch and code in same file
@ 2018-10-26 9:37 David Hunt
2018-10-26 11:37 ` Ferruh Yigit
0 siblings, 1 reply; 3+ messages in thread
From: David Hunt @ 2018-10-26 9:37 UTC (permalink / raw)
To: dev; +Cc: thomas, john.mcnamara, 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 <david.hunt@intel.com>
---
doc/guides/contributing/patches.rst | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index a3d788024..ffeb50436 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.
--
2.17.1
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [dpdk-dev] [PATCH] doc/contrib: patch and code in same file
2018-10-26 9:37 [dpdk-dev] [PATCH] doc/contrib: patch and code in same file David Hunt
@ 2018-10-26 11:37 ` Ferruh Yigit
2018-11-24 20:48 ` Thomas Monjalon
0 siblings, 1 reply; 3+ messages in thread
From: Ferruh Yigit @ 2018-10-26 11:37 UTC (permalink / raw)
To: David Hunt, dev; +Cc: thomas, john.mcnamara
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>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [dpdk-dev] [PATCH] doc/contrib: patch and code in same file
2018-10-26 11:37 ` Ferruh Yigit
@ 2018-11-24 20:48 ` Thomas Monjalon
0 siblings, 0 replies; 3+ messages in thread
From: Thomas Monjalon @ 2018-11-24 20:48 UTC (permalink / raw)
To: David Hunt; +Cc: dev, Ferruh Yigit, john.mcnamara
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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2018-11-24 20:48 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-10-26 9:37 [dpdk-dev] [PATCH] doc/contrib: patch and code in same file David Hunt
2018-10-26 11:37 ` Ferruh Yigit
2018-11-24 20:48 ` Thomas Monjalon
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).