[v2] 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 ("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(+)
Comments
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
> ----------------
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.
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.
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
@@ -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
----------------