[dpdk-dev] [PATCH] doc: clarify abi reference version to use in patches

Ray Kinsella mdr at ashroe.eu
Mon Aug 10 11:24:07 CEST 2020


Clarify the ABI reference version (DPDK_ABI_REF_VERSION) tag, to use
when testing builds with devtools/test_build[_meson].sh before
submitting patches.

Signed-off-by: Ray Kinsella <mdr at ashroe.eu>
---
 doc/guides/contributing/patches.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index de493a9..877d2e2 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -532,7 +532,8 @@ 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 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
-- 
2.7.4



More information about the dev mailing list