From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas.monjalon@6wind.com>
Subject: Re: [PATCHv4 4/4] ABI: Add some documentation
Date: Mon, 29 Jun 2015 17:07:31 +0200
Message-ID: <13295974.B6fKNOXleO@xps13>
References: <1435088014-18973-1-git-send-email-nhorman@tuxdriver.com>
 <1435586380-1673-1-git-send-email-nhorman@tuxdriver.com>
 <1435586380-1673-4-git-send-email-nhorman@tuxdriver.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org
To: Neil Horman <nhorman@tuxdriver.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mail-wi0-f174.google.com (mail-wi0-f174.google.com
 [209.85.212.174]) by dpdk.org (Postfix) with ESMTP id 3D4C6C3F8
 for <dev@dpdk.org>; Mon, 29 Jun 2015 17:08:41 +0200 (CEST)
Received: by wibdq8 with SMTP id dq8so75188189wib.1
 for <dev@dpdk.org>; Mon, 29 Jun 2015 08:08:41 -0700 (PDT)
In-Reply-To: <1435586380-1673-4-git-send-email-nhorman@tuxdriver.com>
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

2015-06-29 09:59, Neil Horman:
> People have been asking for ways to use the ABI macros, heres some docs to
> clarify their use.  Included is:
> 
> * An overview of what ABI is
> * Details of the ABI deprecation process
> * Details of the versioning macros
> * Examples of their use
> * Details of how to use the ABI validator
> 
> Thanks to John Mcnamara, who duplicated much of this effort at Intel while I was
> working on it.  Much of the introductory material was gathered and cleaned up by
> him
> 
> Signed-off-by: Neil Horman <nhorman@tuxdriver.com>
> CC: john.mcnamara@intel.com
> CC: thomas.monjalon@6wind.com
> 
> Change notes:
> 
> v2)
>      * Fixed RST indentations and spelling errors
>      * Rebased to upstream to fix index.rst conflict
> 
> v3)
>      * Fixed in tact -> intact
>      * Added docs to address static linking
>      * Removed duplicate documentation from release notes
> 
> v4)
>      * Fixed more grammatical errors / etc
>      * removed BASE_SYMBOL from documentation

Series applied with minor fixes, thanks

This doc should help to produce patches with new ABI without breaking
the old one.
For cases where the backward compatibility is impossible to achieve,
a patch amending this doc to suggest a NEXT_ABI option can be discussed.