From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "Richardson, Bruce" <bruce.richardson@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] doc: update ABI/API policy
Date: Mon, 6 Nov 2017 14:48:58 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23EDF4100@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <20171106112806.104289-1-bruce.richardson@intel.com>
> -----Original Message-----
> From: Richardson, Bruce
> Sent: Monday, November 6, 2017 11:28 AM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Richardson, Bruce <bruce.richardson@intel.com>
> Subject: [PATCH] doc: update ABI/API policy
>
> Following agreement at the DPDK Technical Board meeting of 2017-10-13 [1],
> update the documentation with the ABI/API policy changes.
>
> [1] http://dpdk.org/ml/archives/dev/2017-October/079961.html
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
> doc/guides/contributing/versioning.rst | 19 ++++++++++++++++++-
> 1 file changed, 18 insertions(+), 1 deletion(-)
>
> diff --git a/doc/guides/contributing/versioning.rst
> b/doc/guides/contributing/versioning.rst
> index 8d0fdb777..a1d8492a1 100644
> --- a/doc/guides/contributing/versioning.rst
> +++ b/doc/guides/contributing/versioning.rst
> @@ -13,7 +13,9 @@ General Guidelines
> ------------------
>
> #. Whenever possible, ABI should be preserved -#. The libraries marked in
> experimental state may change without constraint.
> +#. Libraries or APIs marked in ``experimental`` state may change without
> constraint.
> +#. New API will be marked as ``experimental`` for at least one release to
s/API/APIs/
> +APIs marked as ``experimental`` are not considered part of the ABI and
> +may change without warning at any time. Since changes to APIs are most
> +likely immediately after their introduction, as users begin to take
> +advantage of those new API and start finding issues with them, new DPDK
s/API/APIs/
> + - The acknowledgment of the maintainer of the component is mandatory, or if
> + no maintainer is available for the component, the tree/sub-tree maintainer
> + for that component must be acknowledge the ABI change instead.
s/must be/must/
Apart from that:
Acked-by: John McNamara <john.mcnamara@intel.com>
next prev parent reply other threads:[~2017-11-06 14:49 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-06 11:28 Bruce Richardson
2017-11-06 14:48 ` Mcnamara, John [this message]
2017-11-11 11:37 ` Thomas Monjalon
2017-11-07 6:05 ` Yuanhan Liu
2017-11-08 19:09 ` Kevin Traynor
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=B27915DBBA3421428155699D51E4CFE23EDF4100@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).