doc: clarify abi reference version to use in patches
Checks
Commit Message
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@ashroe.eu>
---
doc/guides/contributing/patches.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
Comments
On Mon, Aug 10, 2020 at 11:24 AM Ray Kinsella <mdr@ashroe.eu> wrote:
>
> Clarify the ABI reference version (DPDK_ABI_REF_VERSION) tag, to use
> when testing builds with devtools/test_build[_meson].sh before
devtools/test-meson-builds.sh*
> submitting patches.
>
> Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
Reviewed-by: David Marchand <david.marchand@redhat.com>
Applied, thanks.
@@ -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