From: Ray Kinsella <mdr@ashroe.eu>
To: dev@dpdk.org
Cc: ferruh.yigit@intel.com, Ray Kinsella <mdr@ashroe.eu>,
John McNamara <john.mcnamara@intel.com>,
Marko Kovacevic <marko.kovacevic@intel.com>
Subject: [dpdk-dev] [PATCH] doc: clarify abi reference version to use in patches
Date: Mon, 10 Aug 2020 10:24:07 +0100 [thread overview]
Message-ID: <1597051449-500-1-git-send-email-mdr@ashroe.eu> (raw)
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(-)
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
next reply other threads:[~2020-08-10 9:24 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-10 9:24 Ray Kinsella [this message]
2020-11-27 14:37 ` David Marchand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1597051449-500-1-git-send-email-mdr@ashroe.eu \
--to=mdr@ashroe.eu \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).