From: Ray Kinsella Date: Mon, 10 Aug 2020 09:24:07 +0000 (+0100) Subject: doc: clarify reference version for ABI checks X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=e25156a8718e615cb0c3cefc258348715805d596;p=dpdk.git doc: clarify reference version for ABI checks 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 Reviewed-by: David Marchand --- diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index ecec5b7ef6..4e9140bca4 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -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