From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 4222CA00C3; Thu, 14 May 2020 08:40:37 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id A84E01D5D8; Thu, 14 May 2020 08:40:36 +0200 (CEST) Received: from qrelay158.mxroute.com (qrelay158.mxroute.com [172.82.139.158]) by dpdk.org (Postfix) with ESMTP id 6E2EA1D5D5 for ; Thu, 14 May 2020 08:40:35 +0200 (CEST) Received: from filter003.mxroute.com ([168.235.111.26] 168-235-111-26.cloud.ramnode.com) (Authenticated sender: mN4UYu2MZsgR) by qrelay158.mxroute.com (ZoneMTA) with ESMTPA id 17211e9bcce000add6.001 for ; Thu, 14 May 2020 06:40:30 +0000 X-Zone-Loop: 552ca3235c3cb1c1f79ddb994dceb7be96d0d2e3b2c2 X-Originating-IP: [168.235.111.26] Received: from galaxy.mxroute.com (unknown [23.92.70.113]) by filter003.mxroute.com (Postfix) with ESMTPS id 061F96002C; Thu, 14 May 2020 06:40:25 +0000 (UTC) Received: from [192.198.151.44] by galaxy.mxroute.com with esmtpsa (TLSv1.2:ECDHE-RSA-AES128-GCM-SHA256:128) (Exim 4.91) (envelope-from ) id 1jZ76E-0006X2-VQ; Thu, 14 May 2020 02:12:07 -0400 To: Gaetan Rivet , dev@dpdk.org Cc: Neil Horman , "Mcnamara, John" , Marko Kovacevic References: <20200513104301.46043-1-grive@u256.net> From: Ray Kinsella Autocrypt: addr=mdr@ashroe.eu; keydata= mQINBFv8B3wBEAC+5ImcgbIvadt3axrTnt7Sxch3FsmWTTomXfB8YiuHT8KL8L/bFRQSL1f6 ASCHu3M89EjYazlY+vJUWLr0BhK5t/YI7bQzrOuYrl9K94vlLwzD19s/zB/g5YGGR5plJr0s JtJsFGEvF9LL3e+FKMRXveQxBB8A51nAHfwG0WSyx53d61DYz7lp4/Y4RagxaJoHp9lakn8j HV2N6rrnF+qt5ukj5SbbKWSzGg5HQF2t0QQ5tzWhCAKTfcPlnP0GymTBfNMGOReWivi3Qqzr S51Xo7hoGujUgNAM41sxpxmhx8xSwcQ5WzmxgAhJ/StNV9cb3HWIoE5StCwQ4uXOLplZNGnS uxNdegvKB95NHZjRVRChg/uMTGpg9PqYbTIFoPXjuk27sxZLRJRrueg4tLbb3HM39CJwSB++ YICcqf2N+GVD48STfcIlpp12/HI+EcDSThzfWFhaHDC0hyirHxJyHXjnZ8bUexI/5zATn/ux TpMbc/vicJxeN+qfaVqPkCbkS71cHKuPluM3jE8aNCIBNQY1/j87k5ELzg3qaesLo2n1krBH bKvFfAmQuUuJT84/IqfdVtrSCTabvDuNBDpYBV0dGbTwaRfE7i+LiJJclUr8lOvHUpJ4Y6a5 0cxEPxm498G12Z3NoY/mP5soItPIPtLR0rA0fage44zSPwp6cQARAQABtBxSYXkgS2luc2Vs bGEgPG1kckBhc2hyb2UuZXU+iQJUBBMBCAA+FiEEcDUDlKDJaDuJlfZfdJdaH/sCCpsFAlv8 B3wCGyMFCQlmAYAFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQdJdaH/sCCptdtRAAl0oE msa+djBVYLIsax+0f8acidtWg2l9f7kc2hEjp9h9aZCpPchQvhhemtew/nKavik3RSnLTAyn B3C/0GNlmvI1l5PFROOgPZwz4xhJKGN7jOsRrbkJa23a8ly5UXwF3Vqnlny7D3z+7cu1qq/f VRK8qFyWkAb+xgqeZ/hTcbJUWtW+l5Zb+68WGEp8hB7TuJLEWb4+VKgHTpQ4vElYj8H3Z94a 04s2PJMbLIZSgmKDASnyrKY0CzTpPXx5rSJ1q+B1FCsfepHLqt3vKSALa3ld6bJ8fSJtDUJ7 JLiU8dFZrywgDIVme01jPbjJtUScW6jONLvhI8Z2sheR71UoKqGomMHNQpZ03ViVWBEALzEt TcjWgJFn8yAmxqM4nBnZ+hE3LbMo34KCHJD4eg18ojDt3s9VrDLa+V9fNxUHPSib9FD9UX/1 +nGfU/ZABmiTuUDM7WZdXri7HaMpzDRJUKI6b+/uunF8xH/h/MHW16VuMzgI5dkOKKv1LejD dT5mA4R+2zBS+GsM0oa2hUeX9E5WwjaDzXtVDg6kYq8YvEd+m0z3M4e6diFeLS77/sAOgaYL 92UcoKD+Beym/fVuC6/55a0e12ksTmgk5/ZoEdoNQLlVgd2INtvnO+0k5BJcn66ZjKn3GbEC VqFbrnv1GnA58nEInRCTzR1k26h9nmS5Ag0EW/wHfAEQAMth1vHr3fOZkVOPfod3M6DkQir5 xJvUW5EHgYUjYCPIa2qzgIVVuLDqZgSCCinyooG5dUJONVHj3nCbITCpJp4eB3PI84RPfDcC hf/V34N/Gx5mTeoymSZDBmXT8YtvV/uJvn+LvHLO4ZJdvq5ZxmDyxfXFmkm3/lLw0+rrNdK5 pt6OnVlCqEU9tcDBezjUwDtOahyV20XqxtUttN4kQWbDRkhT+HrA9WN9l2HX91yEYC+zmF1S OhBqRoTPLrR6g4sCWgFywqztpvZWhyIicJipnjac7qL/wRS+wrWfsYy6qWLIV80beN7yoa6v ccnuy4pu2uiuhk9/edtlmFE4dNdoRf7843CV9k1yRASTlmPkU59n0TJbw+okTa9fbbQgbIb1 pWsAuicRHyLUIUz4f6kPgdgty2FgTKuPuIzJd1s8s6p2aC1qo+Obm2gnBTduB+/n1Jw+vKpt 07d+CKEKu4CWwvZZ8ktJJLeofi4hMupTYiq+oMzqH+V1k6QgNm0Da489gXllU+3EFC6W1qKj tkvQzg2rYoWeYD1Qn8iXcO4Fpk6wzylclvatBMddVlQ6qrYeTmSbCsk+m2KVrz5vIyja0o5Y yfeN29s9emXnikmNfv/dA5fpi8XCANNnz3zOfA93DOB9DBf0TQ2/OrSPGjB3op7RCfoPBZ7u AjJ9dM7VABEBAAGJAjwEGAEIACYWIQRwNQOUoMloO4mV9l90l1of+wIKmwUCW/wHfAIbDAUJ CWYBgAAKCRB0l1of+wIKm3KlD/9w/LOG5rtgtCUWPl4B3pZvGpNym6XdK8cop9saOnE85zWf u+sKWCrxNgYkYP7aZrYMPwqDvilxhbTsIJl5HhPgpTO1b0i+c0n1Tij3EElj5UCg3q8mEc17 c+5jRrY3oz77g7E3oPftAjaq1ybbXjY4K32o3JHFR6I8wX3m9wJZJe1+Y+UVrrjY65gZFxcA thNVnWKErarVQGjeNgHV4N1uF3pIx3kT1N4GSnxhoz4Bki91kvkbBhUgYfNflGURfZT3wIKK +d50jd7kqRouXUCzTdzmDh7jnYrcEFM4nvyaYu0JjSS5R672d9SK5LVIfWmoUGzqD4AVmUW8 pcv461+PXchuS8+zpltR9zajl72Q3ymlT4BTAQOlCWkD0snBoKNUB5d2EXPNV13nA0qlm4U2 GpROfJMQXjV6fyYRvttKYfM5xYKgRgtP0z5lTAbsjg9WFKq0Fndh7kUlmHjuAIwKIV4Tzo75 QO2zC0/NTaTjmrtiXhP+vkC4pcrOGNsbHuaqvsc/ZZ0siXyYsqbctj/sCd8ka2r94u+c7o4l BGaAm+FtwAfEAkXHu4y5Phuv2IRR+x1wTey1U1RaEPgN8xq0LQ1OitX4t2mQwjdPihZQBCnZ wzOrkbzlJMNrMKJpEgulmxAHmYJKgvZHXZXtLJSejFjR0GdHJcL5rwVOMWB8cg== Message-ID: Date: Thu, 14 May 2020 07:40:21 +0100 User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:68.0) Gecko/20100101 Thunderbird/68.8.0 MIME-Version: 1.0 In-Reply-To: <20200513104301.46043-1-grive@u256.net> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 8bit X-AuthUser: mdr@ashroe.eu Subject: Re: [dpdk-dev] [PATCH v1] doc: fix typos and errors in abi policy doc X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" CC: John + Marko Gaetan, Looks good, thank you for the tidy up. On 13/05/2020 11:43, Gaetan Rivet wrote: > Some errors in the document: > > * API instead of ABI once. > > Some typos: > > * __rte_depreciated instead of __rte_deprecated. > * missing ```` around value. > * inconsistent reference to major ABI version, most > of the time described without the minor appended, except once. > > Verbosity and grammar: > > * Long sentences that would be better cut short. > * Comma abuse. > * 'May' used where 'can' seems more fitting. > > I'm not a native speaker though, so grain of salt applies. > > Fixes: fdf7471cccb8 ("doc: introduce major ABI versions") > Cc: Ray Kinsella > cc: Neil Horman > Signed-off-by: Gaetan Rivet > --- > doc/guides/contributing/abi_policy.rst | 21 ++++++++++----------- > 1 file changed, 10 insertions(+), 11 deletions(-) > > diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst > index 05ca95980..2198519d9 100644 > --- a/doc/guides/contributing/abi_policy.rst > +++ b/doc/guides/contributing/abi_policy.rst > @@ -220,19 +220,18 @@ Examples of ABI Changes > The following are examples of allowable ABI changes occurring between > declarations of major ABI versions. > > -* DPDK 19.11 release, defines the function ``rte_foo()``, and ``rte_foo()`` > - as part of the major ABI version ``20``. > +* DPDK 19.11 release defines the function ``rte_foo()`` ; ``rte_foo()`` > + is part of the major ABI version ``20``. > > -* DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``, and > - this is not a problem as long as the symbol ``rte_foo@DPDK20`` is > +* DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``. > + This is not a problem as long as the symbol ``rte_foo@DPDK20`` is > preserved through :ref:`abi_versioning`. > > - The new function may be marked with the ``__rte_experimental`` tag for a > number of releases, as described in the section :ref:`experimental_apis`. > > - - Once ``rte_foo(uint8_t bar)`` becomes non-experimental ``rte_foo()`` is then > - declared as ``__rte_depreciated``, with an associated deprecation notice > - provided. > + - Once ``rte_foo(uint8_t bar)`` becomes non-experimental, ``rte_foo()`` is > + declared as ``__rte_deprecated`` and an deprecation notice is provided. > > * DPDK 19.11 is not re-released to include ``rte_foo(uint8_t bar)``, the new > version of ``rte_foo`` only exists from DPDK 20.02 onwards as described in the > @@ -242,13 +241,13 @@ declarations of major ABI versions. > rte_baz()``. This function may or may not exist in the DPDK 20.05 release. > > * An application ``dPacket`` wishes to use ``rte_foo(uint8_t bar)``, before the > - declaration of the DPDK ``21`` major API version. The application can only > + declaration of the DPDK ``21`` major ABI version. The application can only > ensure its runtime dependencies are met by specifying ``DPDK (>= 20.2)`` as > - an explicit package dependency, as the soname only may only indicate the > + an explicit package dependency, as the soname can only indicate the > supported major ABI version. > > * At the release of DPDK 20.11, the function ``rte_foo(uint8_t bar)`` becomes > - formally part of then new major ABI version DPDK 21.0 and ``rte_foo()`` may be > + formally part of then new major ABI version DPDK ``21`` and ``rte_foo()`` may be > removed. > > .. _deprecation_notices: > @@ -322,6 +321,6 @@ Libraries > > Libraries marked as ``experimental`` are entirely not considered part of an ABI > version, and may change without warning at any time. Experimental libraries > -always have a major version of ``0`` to indicate they exist outside of > +always have a major ABI version of ``0`` to indicate they exist outside of > :ref:`abi_versioning` , with the minor version incremented with each ABI change > to library. > Acked-by: Ray Kinsella