[dpdk-dev] [PATCH] doc: add dependency syntax to contributing guide

[dpdk-dev] [PATCH] doc: add dependency syntax to contributing guide

[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'

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Cc: ci@dpdk.org
---
 doc/guides/contributing/patches.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 1c6a04100..54dbb0508 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -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
 ----------------
-- 
2.25.4

Re: [dpdk-dev] [dpdk-ci] [PATCH] doc: add dependency syntax to contributing guide

[Thomas Monjalon]

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")

Re: [dpdk-dev] [dpdk-ci] [PATCH] doc: add dependency syntax to contributing guide

[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?

Re: [dpdk-dev] [dpdk-ci] [PATCH] doc: add dependency syntax to contributing guide

[Thomas Monjalon]

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.

Re: [dpdk-dev] [dpdk-ci] [PATCH] doc: add dependency syntax to contributing guide

[Ferruh Yigit]

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

[dpdk-dev] [PATCH v2] doc: add dependency syntax to contributing guide

[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 ("Title of the series")'
OR
'Depends-on: patch-NNNNN ("Title of the patch")'

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Cc: ci@dpdk.org

v2:
* Add patch/series title as part of syntax
---
 doc/guides/contributing/patches.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 16b40225f..73f71fc69 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -336,6 +336,24 @@ 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 ("Title of the series")`` or ``Depends-on: patch-NNNNN ("Title of the patch")``
+
+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 ("Title of the series")
 
 Creating Patches
 ----------------
-- 
2.25.4

Re: [dpdk-dev] [dpdk-ci] [PATCH v2] doc: add dependency syntax to contributing guide

[Aaron Conole]

Ferruh Yigit <ferruh.yigit@intel.com> writes:

> 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 ("Title of the series")'
> OR
> 'Depends-on: patch-NNNNN ("Title of the patch")'
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---

Is the plan that these must be scrubbed before committing?

This data doesn't seem useful in the history.  I would prefer it in the
subject like

[PATCH series-xxxx] lorem ipsum

Since the metadata gets scrubbed.

> Cc: ci@dpdk.org
>
> v2:
> * Add patch/series title as part of syntax
> ---
>  doc/guides/contributing/patches.rst | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
>
> diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
> index 16b40225f..73f71fc69 100644
> --- a/doc/guides/contributing/patches.rst
> +++ b/doc/guides/contributing/patches.rst
> @@ -336,6 +336,24 @@ 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 ("Title of the series")`` or ``Depends-on: patch-NNNNN ("Title of the patch")``
> +
> +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 ("Title of the series")
>  
>  Creating Patches
>  ----------------

Re: [dpdk-dev] [dpdk-ci] [PATCH v2] doc: add dependency syntax to contributing guide

[Thomas Monjalon]

06/07/2020 17:09, Aaron Conole:
> Ferruh Yigit <ferruh.yigit@intel.com> writes:
> 
> > 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 ("Title of the series")'
> > OR
> > 'Depends-on: patch-NNNNN ("Title of the patch")'
> >
> > Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> > ---
> 
> Is the plan that these must be scrubbed before committing?
> 
> This data doesn't seem useful in the history.  I would prefer it in the
> subject like
> 
> [PATCH series-xxxx] lorem ipsum
> 
> Since the metadata gets scrubbed.

Look below:

> > +     Signed-off-by: Alex Smith <alex.smith@example.com>
> > +     ---
> > +     Depends-on: series-10000 ("Title of the series")

Added after line ---
so it won't be kept in the git history.

Re: [dpdk-dev] [dpdk-ci] [PATCH v2] doc: add dependency syntax to contributing guide

[Aaron Conole]

Thomas Monjalon <thomas@monjalon.net> writes:

> 06/07/2020 17:09, Aaron Conole:
>> Ferruh Yigit <ferruh.yigit@intel.com> writes:
>> 
>> > 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 ("Title of the series")'
>> > OR
>> > 'Depends-on: patch-NNNNN ("Title of the patch")'
>> >
>> > Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
>> > ---
>> 
>> Is the plan that these must be scrubbed before committing?
>> 
>> This data doesn't seem useful in the history.  I would prefer it in the
>> subject like
>> 
>> [PATCH series-xxxx] lorem ipsum
>> 
>> Since the metadata gets scrubbed.
>
> Look below:
>
>> > +     Signed-off-by: Alex Smith <alex.smith@example.com>
>> > +     ---
>> > +     Depends-on: series-10000 ("Title of the series")
>
> Added after line ---
> so it won't be kept in the git history.

Ahh, I missed it for some reason.

Re: [dpdk-dev] [PATCH v2] doc: add dependency syntax to contributing guide

[Thomas Monjalon]

03/07/2020 11:53, 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 ("Title of the series")'
> OR
> 'Depends-on: patch-NNNNN ("Title of the patch")'
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied, thanks