DPDK patches and discussions
 help / color / Atom feed
* [dpdk-dev] [PATCH] doc: add dependency syntax to contributing guide
@ 2020-07-01 11:35 Ferruh Yigit
  2020-07-01 11:59 ` [dpdk-dev] [dpdk-ci] " Thomas Monjalon
  2020-07-03  9:53 ` [dpdk-dev] [PATCH v2] " Ferruh Yigit
  0 siblings, 2 replies; 10+ messages in thread
From: Ferruh Yigit @ 2020-07-01 11:35 UTC (permalink / raw)
  To: John McNamara, Marko Kovacevic; +Cc: dev, Ferruh Yigit, ci

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


^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [dpdk-dev] [dpdk-ci] [PATCH] doc: add dependency syntax to contributing guide
  2020-07-01 11:35 [dpdk-dev] [PATCH] doc: add dependency syntax to contributing guide Ferruh Yigit
@ 2020-07-01 11:59 ` " Thomas Monjalon
  2020-07-02 16:13   ` Ferruh Yigit
  2020-07-03  9:53 ` [dpdk-dev] [PATCH v2] " Ferruh Yigit
  1 sibling, 1 reply; 10+ messages in thread
From: Thomas Monjalon @ 2020-07-01 11:59 UTC (permalink / raw)
  To: Ferruh Yigit; +Cc: John McNamara, Marko Kovacevic, ci, dev

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






^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [dpdk-dev] [dpdk-ci] [PATCH] doc: add dependency syntax to contributing guide
  2020-07-01 11:59 ` [dpdk-dev] [dpdk-ci] " Thomas Monjalon
@ 2020-07-02 16:13   ` Ferruh Yigit
  2020-07-03  9:01     ` Thomas Monjalon
  0 siblings, 1 reply; 10+ messages in thread
From: Ferruh Yigit @ 2020-07-02 16:13 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: John McNamara, Marko Kovacevic, ci, dev

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?


^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [dpdk-dev] [dpdk-ci] [PATCH] doc: add dependency syntax to contributing guide
  2020-07-02 16:13   ` Ferruh Yigit
@ 2020-07-03  9:01     ` Thomas Monjalon
  2020-07-03  9:03       ` Ferruh Yigit
  0 siblings, 1 reply; 10+ messages in thread
From: Thomas Monjalon @ 2020-07-03  9:01 UTC (permalink / raw)
  To: Ferruh Yigit; +Cc: John McNamara, Marko Kovacevic, ci, dev

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.



^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [dpdk-dev] [dpdk-ci] [PATCH] doc: add dependency syntax to contributing guide
  2020-07-03  9:01     ` Thomas Monjalon
@ 2020-07-03  9:03       ` Ferruh Yigit
  0 siblings, 0 replies; 10+ messages in thread
From: Ferruh Yigit @ 2020-07-03  9:03 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: John McNamara, Marko Kovacevic, ci, dev

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

^ permalink raw reply	[flat|nested] 10+ messages in thread

* [dpdk-dev] [PATCH v2] doc: add dependency syntax to contributing guide
  2020-07-01 11:35 [dpdk-dev] [PATCH] doc: add dependency syntax to contributing guide Ferruh Yigit
  2020-07-01 11:59 ` [dpdk-dev] [dpdk-ci] " Thomas Monjalon
@ 2020-07-03  9:53 ` " Ferruh Yigit
  2020-07-06 15:09   ` [dpdk-dev] [dpdk-ci] " Aaron Conole
  2020-07-30 23:13   ` [dpdk-dev] " Thomas Monjalon
  1 sibling, 2 replies; 10+ messages in thread
From: Ferruh Yigit @ 2020-07-03  9:53 UTC (permalink / raw)
  To: John McNamara, Marko Kovacevic; +Cc: dev, Ferruh Yigit, Thomas Monjalon, ci

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


^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [dpdk-dev] [dpdk-ci] [PATCH v2] doc: add dependency syntax to contributing guide
  2020-07-03  9:53 ` [dpdk-dev] [PATCH v2] " Ferruh Yigit
@ 2020-07-06 15:09   ` " Aaron Conole
  2020-07-06 15:12     ` Thomas Monjalon
  2020-07-30 23:13   ` [dpdk-dev] " Thomas Monjalon
  1 sibling, 1 reply; 10+ messages in thread
From: Aaron Conole @ 2020-07-06 15:09 UTC (permalink / raw)
  To: Ferruh Yigit; +Cc: John McNamara, Marko Kovacevic, dev, Thomas Monjalon, ci

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


^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [dpdk-dev] [dpdk-ci] [PATCH v2] doc: add dependency syntax to contributing guide
  2020-07-06 15:09   ` [dpdk-dev] [dpdk-ci] " Aaron Conole
@ 2020-07-06 15:12     ` Thomas Monjalon
  2020-07-06 18:02       ` Aaron Conole
  0 siblings, 1 reply; 10+ messages in thread
From: Thomas Monjalon @ 2020-07-06 15:12 UTC (permalink / raw)
  To: Aaron Conole; +Cc: Ferruh Yigit, John McNamara, Marko Kovacevic, dev, ci

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.



^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [dpdk-dev] [dpdk-ci] [PATCH v2] doc: add dependency syntax to contributing guide
  2020-07-06 15:12     ` Thomas Monjalon
@ 2020-07-06 18:02       ` Aaron Conole
  0 siblings, 0 replies; 10+ messages in thread
From: Aaron Conole @ 2020-07-06 18:02 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: Ferruh Yigit, John McNamara, Marko Kovacevic, dev, ci

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.


^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [dpdk-dev] [PATCH v2] doc: add dependency syntax to contributing guide
  2020-07-03  9:53 ` [dpdk-dev] [PATCH v2] " Ferruh Yigit
  2020-07-06 15:09   ` [dpdk-dev] [dpdk-ci] " Aaron Conole
@ 2020-07-30 23:13   ` " Thomas Monjalon
  1 sibling, 0 replies; 10+ messages in thread
From: Thomas Monjalon @ 2020-07-30 23:13 UTC (permalink / raw)
  To: Ferruh Yigit; +Cc: John McNamara, Marko Kovacevic, dev, ci

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



^ permalink raw reply	[flat|nested] 10+ messages in thread

end of thread, back to index

Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-01 11:35 [dpdk-dev] [PATCH] doc: add dependency syntax to contributing guide Ferruh Yigit
2020-07-01 11:59 ` [dpdk-dev] [dpdk-ci] " Thomas Monjalon
2020-07-02 16:13   ` Ferruh Yigit
2020-07-03  9:01     ` Thomas Monjalon
2020-07-03  9:03       ` Ferruh Yigit
2020-07-03  9:53 ` [dpdk-dev] [PATCH v2] " Ferruh Yigit
2020-07-06 15:09   ` [dpdk-dev] [dpdk-ci] " Aaron Conole
2020-07-06 15:12     ` Thomas Monjalon
2020-07-06 18:02       ` Aaron Conole
2020-07-30 23:13   ` [dpdk-dev] " Thomas Monjalon

DPDK patches and discussions

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ http://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/ public-inbox