X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcontributing%2Fpatches.rst;h=6dbbd5f8d104ea4f14098adc81987e551cd4ec6d;hb=2e4859f3b362fa2960d71dc70b77a13a24f5c228;hp=9ff60944c374ae3f3489ffaa4cec55fedc76a8a6;hpb=3cc6ecfdfe85d2577fef30e1791bb7534e3d60b3;p=dpdk.git diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 9ff60944c3..6dbbd5f8d1 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -32,9 +32,12 @@ The mailing list for DPDK development is `dev@dpdk.org `_ in order to submit patches. It is also worth registering for the DPDK `Patchwork `_ -If you are using the GitHub service, you can link your repository to -the ``travis-ci.org`` build service. When you push patches to your GitHub -repository, the travis service will automatically build your changes. +If you are using the GitHub service, pushing to a branch will trigger GitHub +Actions to automatically build your changes and run unit tests and ABI checks. + +Additionally, a Travis configuration is available in DPDK but Travis free usage +is limited to a few builds. +You can link your repository to the ``travis-ci.com`` build service. The development process requires some familiarity with the ``git`` version control system. Refer to the `Pro Git Book `_ for further information. @@ -484,14 +487,19 @@ Checking ABI compatibility By default, ABI compatibility checks are disabled. To enable them, a reference version must be selected via the environment -variable ``DPDK_ABI_REF_VERSION``. +variable ``DPDK_ABI_REF_VERSION``. Contributors should ordinarily reference the +git tag of the most recent release of DPDK in ``DPDK_ABI_REF_VERSION``. -The ``devtools/test-build.sh`` and ``devtools/test-meson-builds.sh`` scripts -then build this reference version in a temporary directory and store the -results in a subfolder of the current working directory. +The ``devtools/test-meson-builds.sh`` script then build this reference version +in a temporary directory and store the results in a subfolder of the current +working directory. The environment variable ``DPDK_ABI_REF_DIR`` can be set so that the results go to a different location. +Sample:: + + DPDK_ABI_REF_VERSION=v19.11 DPDK_ABI_REF_DIR=/tmp ./devtools/test-meson-builds.sh + Sending Patches ---------------