[dpdk-dev] [PATCH v8 4/4] docs: Add ABI documentation

[Neil Horman]

On Mon, Feb 02, 2015 at 05:52:44PM +0100, Thomas Monjalon wrote:
> 2015-01-22 10:49, Neil Horman:
> > Adding a document describing rudimentary ABI policy and adding notice space for
> > any deprecation announcements
> > 
> > Signed-off-by: Neil Horman <nhorman at tuxdriver.com>
> > CC: Thomas Monjalon <thomas.monjalon at 6wind.com>
> > CC: "Richardson, Bruce" <bruce.richardson at intel.com>
> [...]
> > +Examples of Deprecation notices
> > +-------------------------------
> 
> Curiosity: what is the rule to use uppercase letter in an english title?
> 

According to MLA:
https://owl.english.purdue.edu/owl/resource/747/01/
Section and Title headings should use title case, capitalizing the primary
words.  As such the n in notices should be capitalized.

> > +* The Macro #RTE_FOO is deprecated and will be removed with version 2.0, to be replaced with the inline function rte_bar()
> > +* The function rte_mbuf_grok has been updated to include new parameter in version 2.0.  Backwards compatibility will be maintained for this function until the release of version 2.1
> > +* The members struct foo have been reorganized in release 2.0.  Existing binary applications will have backwards compatibility in release 2.0, while newly built binaries will need to reference new structure variant struct foo2.  Compatibility will be removed in release 2.2, and all applications will require updating a rebuilding to the new structure at that time, which will be renamed to the origional struct foo.
> 
> What means "will require updating a rebuilding to the new structure"?
> 
the "a" should be "and"

> origional -> original
> 
> > +* Significant ABI changes are planned for the librte_dostuff library.  The upcomming release 2.0 will not contain these changes, but release 2.1 will, and no backwards compatibility is planned due to the invasive nature of these changes.  Binaries using this library built prior to version 2.1 will require updating and recompilation.
> 
> upcomming -> upcoming
> 
Very will, I'll send an updated version of this patch.

> Thanks
> -- 
> Thomas
>