[dpdk-dev] [PATCH] doc: Changes to ABI Policy introducing major ABI versions

Mcnamara, John john.mcnamara at intel.com
Tue Jul 30 12:34:11 CEST 2019



> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Ray Kinsella
> Sent: Thursday, July 4, 2019 1:27 PM
> To: dev at dpdk.org
> Cc: mdr at ashroe.eu
> Subject: [dpdk-dev] [PATCH] doc: Changes to ABI Policy introducing major
> ABI versions
> 
> This policy change introduces major ABI versions, these are declared every
> two years, typically aligned with the LTS release and are supported by
> subsequent releases for the next two years.
> This change is intended to improve ABI stabilty for those projects
> consuming DPDK.
> 



>...
> 
> +A LTS release may align with the declaration of a new major ABI
> +version, please read the `DPDK ABI/API policy`_ for more information.

This should be  `<DPDK ABI/API policy>`_ to avoid a build warning/error
since the target contains spaces.

Also, the subject line should be lowercase by convention, apart from acronyms.

    $ ./devtools/check-git-log.sh 
    Wrong headline uppercase:
        doc: >C<hanges to ABI Policy introducing major ABI versions

Something like:

    doc: changes to ABI policy introducing major ABI versions

John




More information about the dev mailing list