doc: clarify reference version for ABI checks
authorRay Kinsella <mdr@ashroe.eu>
Mon, 10 Aug 2020 09:24:07 +0000 (10:24 +0100)
committerDavid Marchand <david.marchand@redhat.com>
Fri, 27 Nov 2020 14:41:32 +0000 (15:41 +0100)
Clarify the ABI reference version (DPDK_ABI_REF_VERSION) tag, to use
when testing builds with devtools/test-meson-builds.sh before
submitting patches.

Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
Reviewed-by: David Marchand <david.marchand@redhat.com>
doc/guides/contributing/patches.rst

index ecec5b7..4e9140b 100644 (file)
@@ -484,7 +484,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 the most recent release of DPDK in ``DPDK_ABI_REF_VERSION``.
 
 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