[dpdk-dev] [PATCH] doc: add sample for ABI checks in contribution guide

[Kinsella, Ray]

On 07/08/2020 00:43, Thomas Monjalon wrote:
> +Cc David, Neil and Ray
> 
> 03/07/2020 19:15, Ferruh Yigit:
>> Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>
>> ---
>>  doc/guides/contributing/patches.rst | 4 ++++
>>  1 file changed, 4 insertions(+)
>>
>> diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
>> index 25d97b85b..39ec64ec8 100644
>> --- a/doc/guides/contributing/patches.rst
>> +++ b/doc/guides/contributing/patches.rst
>> @@ -550,6 +550,10 @@ results in a subfolder of the current working directory.
>>  The environment variable ``DPDK_ABI_REF_DIR`` can be set so that the results go
>>  to a different location.
>>  
>> +Sample::
>> +
>> +        DPDK_ABI_REF_VERSION=v19.11 DPDK_ABI_REF_DIR=/tmp ./devtools/test-meson-builds.sh
> 
> 
This is good, but I think we ought to include some guidance on what version to use.
What we agreed at the techboard meeting was that the last release should always be used. 

The script should probably automagically select the last version.
That is work to be done, for the moment, it will be sufficient to amend the line

"To enable them, a reference version must be selected via the environment variable DPDK_ABI_REF_VERSION."

to something like

"To enable them, a reference version must be selected via the environment variable DPDK_ABI_REF_VERSION. Contributors should be ordinarily be referencing the most recent release of DPDK."

Make sense?

Thanks,

Ray K