X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcontributing%2Fpatches.rst;h=9ff60944c374ae3f3489ffaa4cec55fedc76a8a6;hb=22a2f54f2534258aa8ebb71cd2109f84968d4f9e;hp=16b40225f25fb1c43b7075e6fffefd9634b156d5;hpb=3d4b2afb73f7f0988f8e66ba1b37f2a446e33868;p=dpdk.git diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 16b40225f2..9ff60944c3 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -118,7 +118,8 @@ The proposer should justify the need for a new sub-tree and should have demonstr The maintainer should be confirmed by an ``ack`` from an existing tree maintainer. Disagreements on trees or maintainers can be brought to the Technical Board. -The backup maintainer for the master tree should be selected from the existing sub-tree maintainers from the project. +The backup maintainer for the main tree should be selected +from the existing sub-tree maintainers of the project. The backup maintainer for a sub-tree should be selected from among the component maintainers within that sub-tree. @@ -319,7 +320,7 @@ For example:: Patch for Stable Releases ~~~~~~~~~~~~~~~~~~~~~~~~~ -All fix patches to the master branch that are candidates for backporting +All fix patches to the main branch that are candidates for backporting should also be CCed to the `stable@dpdk.org `_ mailing list. In the commit message body the Cc: stable@dpdk.org should be inserted as follows:: @@ -336,6 +337,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 `. +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 + --- + Depends-on: series-10000 ("Title of the series") Creating Patches ---------------- @@ -429,78 +448,22 @@ Once the environment variable is set, the script can be run as follows:: The script usage is:: - checkpatches.sh [-h] [-q] [-v] [patch1 [patch2] ...]]" - -Where: - -* ``-h``: help, usage. -* ``-q``: quiet. Don't output anything for files without issues. -* ``-v``: verbose. -* ``patchX``: path to one or more patches. + checkpatches.sh [-h] [-q] [-v] [-nX|-r range|patch1 [patch2] ...] Then the git logs should be checked using the ``check-git-log.sh`` script. The script usage is:: - check-git-log.sh [range] - -Where the range is a ``git log`` option. + check-git-log.sh [-h] [-nX|-r range] +For both of the above scripts, the -n option is used to specify a number of commits from HEAD, +and the -r option allows the user specify a ``git log`` range. .. _contrib_check_compilation: Checking Compilation -------------------- -Makefile System -~~~~~~~~~~~~~~~ - -Compilation of patches and changes should be tested using the ``test-build.sh`` script in the ``devtools`` -directory of the DPDK repo:: - - devtools/test-build.sh x86_64-native-linux-gcc+next+shared - -The script usage is:: - - test-build.sh [-h] [-jX] [-s] [config1 [config2] ...]] - -Where: - -* ``-h``: help, usage. -* ``-jX``: use X parallel jobs in "make". -* ``-s``: short test with only first config and without examples/doc. -* ``config``: default config name plus config switches delimited with a ``+`` sign. - -Examples of configs are:: - - x86_64-native-linux-gcc - x86_64-native-linux-gcc+next+shared - x86_64-native-linux-clang+shared - -The builds can be modified via the following environmental variables: - -* ``DPDK_BUILD_TEST_CONFIGS`` (target1+option1+option2 target2) -* ``DPDK_BUILD_TEST_DIR`` -* ``DPDK_DEP_CFLAGS`` -* ``DPDK_DEP_LDFLAGS`` -* ``DPDK_DEP_PCAP`` (y/[n]) -* ``DPDK_NOTIFY`` (notify-send) - -These can be set from the command line or in the config files shown above in the :ref:`contrib_checkpatch`. - -The recommended configurations and options to test compilation prior to submitting patches are:: - - x86_64-native-linux-gcc+shared+next - x86_64-native-linux-clang+shared - i686-native-linux-gcc - - export DPDK_DEP_ZLIB=y - export DPDK_DEP_PCAP=y - export DPDK_DEP_SSL=y - -Meson System -~~~~~~~~~~~~ - Compilation of patches is to be tested with ``devtools/test-meson-builds.sh`` script. The script internally checks for dependencies, then builds for several