DPDK patches and discussions
 help / color / mirror / Atom feed
From: David Marchand <david.marchand@redhat.com>
To: nhorman@tuxdriver.com
Cc: dev@dpdk.org, Timothy Redaelli <tredaelli@redhat.com>
Subject: [dpdk-dev] Marking symbols as experimental in the headers only
Date: Mon, 3 Dec 2018 14:01:02 +0100	[thread overview]
Message-ID: <CAJFAV8wXqv-gTjKkw7TS3NSMpDuxd7abT7CKzd-j1sF0rUeUOQ@mail.gmail.com> (raw)

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.

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.


-- 
David Marchand

             reply	other threads:[~2018-12-03 13:01 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-03 13:01 David Marchand [this message]
2018-12-03 13:26 ` Ferruh Yigit
2018-12-03 16:47 ` Neil Horman
2018-12-04  8:21   ` David Marchand
2018-12-04 15:14     ` Neil Horman
2018-12-04 20:48       ` David Marchand
2018-12-04 21:34         ` Richardson, Bruce
2018-12-05 12:21         ` Neil Horman
2018-12-05 13:22           ` David Marchand
2018-12-18 10:41             ` David Marchand
2018-12-18 12:25               ` Neil Horman
2018-12-18 12:27                 ` David Marchand
2018-12-19  9:12                   ` David Marchand
2018-12-19 12:39                     ` Neil Horman
2018-12-19 13:46                       ` 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=CAJFAV8wXqv-gTjKkw7TS3NSMpDuxd7abT7CKzd-j1sF0rUeUOQ@mail.gmail.com \
    --to=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=nhorman@tuxdriver.com \
    --cc=tredaelli@redhat.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).