[dpdk-dev] Marking symbols as experimental in the headers only

Ferruh Yigit ferruh.yigit at intel.com
Mon Dec 3 14:26:13 CET 2018


On 12/3/2018 1:01 PM, David Marchand wrote:
> Hello Neil,
> 
> Looking at
> http://doc.dpdk.org/guides/contributing/versioning.html#experimental-apis,
> is there a real need to mark both the definition and the declaration of a
> symbol with the __rte_experimental marker ?
> 
> My understanding is that the whole point of having this marker is so that
> rte_compat.h check trigger warnings when trying to use such a symbol from
> the caller side.
> As long as the header where the symbol is published is included from the
> file that defines the symbol, then the forward declaration ensures the
> symbol will catch the tag, right ?
> 
> I would prefer marking the symbols only once in the header and write this
> as the recommended way in the documentation.

+1

> 
> Do you see any issue doing this ?
> 
> 
> We have found an inconsistency, with a symbol marked as experimental in its
> .c but not the .h ... will come up with a fix later.
> 
> 



More information about the dev mailing list