doc: add dependency syntax to contributing guide
Checks
Commit Message
To help managing patch dependencies, both for maintainers or automation
tasks, document a syntax for commit logs or cover letters to express
their dependencies.
Using the syntax proposed in Bugzilla ID 210:
[https://bugs.dpdk.org/show_bug.cgi?id=210]
'Depends-on: series-NNNNN' OR 'Depends-on: patch-NNNNN'
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Cc: ci@dpdk.org
---
doc/guides/contributing/patches.rst | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
Comments
01/07/2020 13:35, Ferruh Yigit:
> To help managing patch dependencies, both for maintainers or automation
> tasks, document a syntax for commit logs or cover letters to express
> their dependencies.
>
> Using the syntax proposed in Bugzilla ID 210:
> [https://bugs.dpdk.org/show_bug.cgi?id=210]
>
> 'Depends-on: series-NNNNN' OR 'Depends-on: patch-NNNNN'
It would be more convenient to add the patch or series title
as we do for "Fixes" tag:
Depends-on: series-NNNNN ("Title of the series")
On 7/1/2020 12:59 PM, Thomas Monjalon wrote:
> 01/07/2020 13:35, Ferruh Yigit:
>> To help managing patch dependencies, both for maintainers or automation
>> tasks, document a syntax for commit logs or cover letters to express
>> their dependencies.
>>
>> Using the syntax proposed in Bugzilla ID 210:
>> [https://bugs.dpdk.org/show_bug.cgi?id=210]
>>
>> 'Depends-on: series-NNNNN' OR 'Depends-on: patch-NNNNN'
>
> It would be more convenient to add the patch or series title
> as we do for "Fixes" tag:
>
> Depends-on: series-NNNNN ("Title of the series")
OK, will update in next version.
Should we enforce any location for the tag, like first of line of the commit log
or cover letter? Does something like this helps to parsers?
02/07/2020 18:13, Ferruh Yigit:
> On 7/1/2020 12:59 PM, Thomas Monjalon wrote:
> > 01/07/2020 13:35, Ferruh Yigit:
> >> To help managing patch dependencies, both for maintainers or automation
> >> tasks, document a syntax for commit logs or cover letters to express
> >> their dependencies.
> >>
> >> Using the syntax proposed in Bugzilla ID 210:
> >> [https://bugs.dpdk.org/show_bug.cgi?id=210]
> >>
> >> 'Depends-on: series-NNNNN' OR 'Depends-on: patch-NNNNN'
> >
> > It would be more convenient to add the patch or series title
> > as we do for "Fixes" tag:
> >
> > Depends-on: series-NNNNN ("Title of the series")
>
> OK, will update in next version.
>
> Should we enforce any location for the tag, like first of line of the commit log
> or cover letter? Does something like this helps to parsers?
It should be in cover letter if there is one.
If no cover letter, I would prefer not having it in git,
so I would suggest having a line of --- before.
On 7/3/2020 10:01 AM, Thomas Monjalon wrote:
> 02/07/2020 18:13, Ferruh Yigit:
>> On 7/1/2020 12:59 PM, Thomas Monjalon wrote:
>>> 01/07/2020 13:35, Ferruh Yigit:
>>>> To help managing patch dependencies, both for maintainers or automation
>>>> tasks, document a syntax for commit logs or cover letters to express
>>>> their dependencies.
>>>>
>>>> Using the syntax proposed in Bugzilla ID 210:
>>>> [https://bugs.dpdk.org/show_bug.cgi?id=210]
>>>>
>>>> 'Depends-on: series-NNNNN' OR 'Depends-on: patch-NNNNN'
>>>
>>> It would be more convenient to add the patch or series title
>>> as we do for "Fixes" tag:
>>>
>>> Depends-on: series-NNNNN ("Title of the series")
>>
>> OK, will update in next version.
>>
>> Should we enforce any location for the tag, like first of line of the commit log
>> or cover letter? Does something like this helps to parsers?
>
> It should be in cover letter if there is one.
> If no cover letter, I would prefer not having it in git,
+1
> so I would suggest having a line of --- before.
OK
@@ -339,6 +339,27 @@ In the commit message body the Cc: stable@dpdk.org should be inserted as follows
For further information on stable contribution you can go to
:doc:`Stable Contribution Guide <stable>`.
+Patch Dependencies
+~~~~~~~~~~~~~~~~~~
+
+Sometimes a patch or patchset can depend on another one.
+To help the maintainers and automation tasks, please document this dependency in commit log or cover letter with the following syntax::
+
+ Depends-on: series-NNNNN
+
+ OR
+
+ Depends-on: patch-NNNNN
+
+Where ``NNNNN`` is patchwork ID for patch or series::
+
+ doc: fix some parameter description
+
+ Update the docs, fixing description of some parameter.
+
+ Signed-off-by: Alex Smith <alex.smith@example.com>
+ ---
+ Depends-on: series-10000
Creating Patches
----------------