From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wg0-f49.google.com (mail-wg0-f49.google.com [74.125.82.49]) by dpdk.org (Postfix) with ESMTP id 2D8945424 for ; Wed, 21 Jan 2015 11:26:12 +0100 (CET) Received: by mail-wg0-f49.google.com with SMTP id l18so13288209wgh.8 for ; Wed, 21 Jan 2015 02:26:12 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:organization :user-agent:in-reply-to:references:mime-version :content-transfer-encoding:content-type; bh=of3YjRSWZJDYR05TnNZO9CgxDz1WMOCxL9WhEtKgZns=; b=mOZGaIATke8HSKGbbIFsbgjXB3AP4ytWynHVdS2qRnq66nWZ9XpyY/u9vtz+FM0o0X IsYfIJzicngY/gyZK07b8llQy1YSmiyb/h7S487QUm9kEFbnxtdv8ANeDJB44igzRx8q Zaz+lfQuKFOHRyGYDIVbFAxpEmNJizeDedHGxlhkMYGTslUB41onuEwoLtQ0jbQPo8LB qg7QYuGPWnYQ34OTHx6MoJOQ6lz67x9e2SruahT41dXK9zcJL8qMMU+FZhTteL43yI/Z qCpF0F3ClnYo7sBxez1u5oLoXZHiOgcmRzLM7NvSwP69tz9Rfhws8XHa/b5PmfYSkQzu zLtg== X-Gm-Message-State: ALoCoQmAVrCmlfuOllJtFdfIR+799VEddpXXjLrgtRMF9lyXfsScr/fNdR5ntZCwlMdS3V4qKdo4 X-Received: by 10.194.203.199 with SMTP id ks7mr79168252wjc.105.1421835972009; Wed, 21 Jan 2015 02:26:12 -0800 (PST) Received: from xps13.localnet (guy78-3-82-239-227-177.fbx.proxad.net. [82.239.227.177]) by mx.google.com with ESMTPSA id e18sm24892287wjz.27.2015.01.21.02.26.10 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 21 Jan 2015 02:26:11 -0800 (PST) From: Thomas Monjalon To: Neil Horman Date: Wed, 21 Jan 2015 11:25:48 +0100 Message-ID: <1771047.ADEq3JXZ2F@xps13> Organization: 6WIND User-Agent: KMail/4.14.3 (Linux/3.18.2-2-ARCH; KDE/4.14.3; x86_64; ; ) In-Reply-To: <1421788679-9433-4-git-send-email-nhorman@tuxdriver.com> References: <1419109299-9603-1-git-send-email-nhorman@tuxdriver.com> <1421788679-9433-1-git-send-email-nhorman@tuxdriver.com> <1421788679-9433-4-git-send-email-nhorman@tuxdriver.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Cc: dev@dpdk.org Subject: Re: [dpdk-dev] [PATCH v6 4/4] docs: Add ABI documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 21 Jan 2015 10:26:12 -0000 2015-01-20 16:17, Neil Horman: > Adding a document describing rudimentary ABI policy and adding notice space for > any deprecation announcements > > Signed-off-by: Neil Horman > CC: Thomas Monjalon > CC: "Richardson, Bruce" > > --- > Change notes: > > v5) Updated documentation to add notes from Thomas M. > > v6) Moved abi.txt to guides/rel_notes/abi.rst You didn't integrate this file in the index. [...] > --- /dev/null > +++ b/doc/guides/rel_notes/abi.rst > @@ -0,0 +1,38 @@ > +ABI policy > +========== > + ABI versions are set at the time of major release labeling, and ABI may > +change multiple times between the last labeling and the HEAD label of the git > +tree without warning > + > + ABI versions, once released are available until such time as their > +deprecation has been noted here for at least one major release cycle, after it > +has been tagged. E.g. the ABI for DPDK 1.8 is shipped, and then the decision to > +remove it is made during the development of DPDK 1.9. The decision will be > +recorded here, shipped with the DPDK 1.9 release, and actually removed when DPDK > +1.10 ships. As previously said, speaking about 2.0/2.1 would be more coherent. > + > + ABI versions may be deprecated in whole, or in part as needed by a given > +update. > + > + Some ABI changes may be too significant to reasonably maintain multiple > +versions of. In those events ABI's may be updated without backward > +compatibility provided. The requirements for doing so are: > + 1) At least 3 acknoweldgements of the need on the dpdk.org > + 2) A full deprecation cycle must be made to offer downstream consumers > +sufficient warning of the change. E.g. if dpdk 2.0 is under development when > +the change is proposed, a deprecation notice must be added to this file, and > +released with dpdk 2.0. Then the change may be incorporated for dpdk 2.1 > + 3) The LIBABIVER variable in the makefilei(s) where the ABI changes are > +incorporated must be incremented in parallel with the ABI changes themselves > + > + Note that the above process for ABI deprecation should not be undertaken > +lightly. ABI stability is extreemely important for downstream consumers of the > +DPDK, especially when distributed in shared object form. Every effort should be > +made to preserve ABI whenever possible. For instance, reorganizing public > +structure field for astetic or readability purposes should be avoided as it will > +cause ABI breakage. Only significant (e.g. performance) reasons should be seen > +as cause to alter ABI. When applying the patch, there are these (minor) warnings: /home/thomas/projects/dpdk/dpdk/.git/rebase-apply/patch:52: trailing whitespace. /home/thomas/projects/dpdk/dpdk/.git/rebase-apply/patch:55: new blank line at EOF. When building the documentation, there are these errors: make doc-guides-html /home/thomas/projects/dpdk/dpdk/doc/guides/rel_notes/abi.rst:4: WARNING: Block quote ends without a blank line; unexpected unindent. /home/thomas/projects/dpdk/dpdk/doc/guides/rel_notes/abi.rst:8: WARNING: Block quote ends without a blank line; unexpected unindent. /home/thomas/projects/dpdk/dpdk/doc/guides/rel_notes/abi.rst:15: WARNING: Block quote ends without a blank line; unexpected unindent. /home/thomas/projects/dpdk/dpdk/doc/guides/rel_notes/abi.rst:18: WARNING: Block quote ends without a blank line; unexpected unindent. /home/thomas/projects/dpdk/dpdk/doc/guides/rel_notes/abi.rst:20: ERROR: Unexpected indentation. /home/thomas/projects/dpdk/dpdk/doc/guides/rel_notes/abi.rst:22: WARNING: Block quote ends without a blank line; unexpected unindent. /home/thomas/projects/dpdk/dpdk/doc/guides/rel_notes/abi.rst:25: ERROR: Unexpected indentation. /home/thomas/projects/dpdk/dpdk/doc/guides/rel_notes/abi.rst:26: WARNING: Block quote ends without a blank line; unexpected unindent. /home/thomas/projects/dpdk/dpdk/doc/guides/rel_notes/abi.rst:29: WARNING: Block quote ends without a blank line; unexpected unindent. /home/thomas/projects/dpdk/dpdk/doc/guides/rel_notes/abi.rst:: WARNING: document isn't included in any toctree Please check it. Other comment, what about the additions I suggested about macros and structure renaming? Neil, we expect that you consider comments done previously and that you test your patch. Otherwise, we are losing time in useless reviews. -- Thomas