FM10K/dpdk-fm10k
FM10K/dpdk-fm10k
1
0
Fork 0
Code Issues Pull requests Releases Activity

doc: add patch dependency syntax to contributing guide

Browse source 
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>
This commit is contained in:
Ferruh Yigit 2020-07-03 10:53:48 +01:00 committed by Thomas Monjalon
parent 0e28cca82a
commit f74904ce98
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/guides/contributing/patches.rst
View file

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