From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dmarchan@redhat.com>
Received: from mail-vk1-f175.google.com (mail-vk1-f175.google.com
 [209.85.221.175]) by dpdk.org (Postfix) with ESMTP id B83922BB1
 for <dev@dpdk.org>; Mon,  3 Dec 2018 14:01:14 +0100 (CET)
Received: by mail-vk1-f175.google.com with SMTP id w72so2862538vkd.5
 for <dev@dpdk.org>; Mon, 03 Dec 2018 05:01:14 -0800 (PST)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20161025;
 h=x-gm-message-state:mime-version:from:date:message-id:subject:to:cc;
 bh=C68f4oBJuv2oWjenG0Darc7vUBSC9KMMIEYXj9JS79s=;
 b=HNfpzChCNy7uVjhdrN+S6YKIfNKkG8PwNO7Kn7PqohrIeqxXlXHXhRBo5TW4Zxuz92
 7e5CT2KB84vJOHQV/QOV/3El9ltIogGlVrBDOfAAwSAc05NfVR+9vVPFZkZdHzMV92LJ
 EmINco22b7mfk/G5QATIxe5KMBMHkPWrljnI1AenbN/YocQpNSjsAQGb0UjjIwnvYMEf
 hJRCVUc5V4hTj1nCQn1qJIDfzqwAaAm17+XpsnrNFmlM19P6equCR2JvKGTw+HhemAUD
 ZQqkLjXjw+NjpEqvJMWx5A8iiQrFOMoMJcFKTaTr9rmD+8a9O4TpTnf81A/d3eoP3SZf
 h5Bg==
X-Gm-Message-State: AA+aEWbPUNY1+BaKp0LA0ohj+ksgMiJniNaTeDBnNa09eEChnA1yskSt
 ON27lR8+xAslYJ3ZfJKVKUk/H1owthTfFhDpno9J+F25Q3w=
X-Google-Smtp-Source: AFSGD/UjjtzncpDS0IlS7dj9e4ssSAPUe0MiLbU/K35bqbTKS6ag8CIwqBDlv1YY9ETp2AbPXgN5/4NThmeH5cIhoWM=
X-Received: by 2002:a1f:1c81:: with SMTP id c123mr6587992vkc.52.1543842074038; 
 Mon, 03 Dec 2018 05:01:14 -0800 (PST)
MIME-Version: 1.0
From: David Marchand <david.marchand@redhat.com>
Date: Mon, 3 Dec 2018 14:01:02 +0100
Message-ID: <CAJFAV8wXqv-gTjKkw7TS3NSMpDuxd7abT7CKzd-j1sF0rUeUOQ@mail.gmail.com>
To: nhorman@tuxdriver.com
Cc: dev@dpdk.org, Timothy Redaelli <tredaelli@redhat.com>
Content-Type: text/plain; charset="UTF-8"
X-Content-Filtered-By: Mailman/MimeDel 2.1.15
Subject: [dpdk-dev] Marking symbols as experimental in the headers only
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Mon, 03 Dec 2018 13:01:14 -0000

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