doc: add ABI guidelines
authorNeil Horman <nhorman@tuxdriver.com>
Mon, 29 Jun 2015 13:59:40 +0000 (09:59 -0400)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Mon, 29 Jun 2015 14:45:01 +0000 (16:45 +0200)
commitf1ef9794f9bd8782374a9225ffc41e491ee27983
treecd35190b33c2850b53334aae7994a0a984090c8d
parenteb8783320e52f9b0671aa82f2d05729584f8559b
doc: add ABI guidelines

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 <john.mcnamara@intel.com>
Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
doc/guides/guidelines/index.rst
doc/guides/guidelines/versioning.rst [new file with mode: 0644]
doc/guides/rel_notes/abi.rst