From patchwork Thu Aug 18 14:09:50 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 74167 Delivered-To: patch@linaro.org Received: by 10.140.29.52 with SMTP id a49csp370795qga; Thu, 18 Aug 2016 07:10:09 -0700 (PDT) X-Received: by 10.55.128.66 with SMTP id b63mr2436100qkd.69.1471529403944; Thu, 18 Aug 2016 07:10:03 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id c186si1329390qkf.208.2016.08.18.07.10.02; Thu, 18 Aug 2016 07:10:03 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 671D26091C; Thu, 18 Aug 2016 14:10:02 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2 autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id DA181609D1; Thu, 18 Aug 2016 14:09:57 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 971C8609F6; Thu, 18 Aug 2016 14:09:55 +0000 (UTC) Received: from mail-qk0-f171.google.com (mail-qk0-f171.google.com [209.85.220.171]) by lists.linaro.org (Postfix) with ESMTPS id 6B7B46091C for ; Thu, 18 Aug 2016 14:09:54 +0000 (UTC) Received: by mail-qk0-f171.google.com with SMTP id v123so17020129qkh.2 for ; Thu, 18 Aug 2016 07:09:54 -0700 (PDT) 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; bh=27FVosWyIzFImTwkthGrbXfT2DhIxNu4zxqhhcL6Cyc=; b=OD4UnJITdUMhaa8roh4IJcD+486Q3HxtoYBESURBHGnYynZ3tDQl2FfpMP1zhjJzw3 XMWoeCm+Naa9FYVokCfsigtCviDzBuVHSAURFzWHiN5EaJ7YViPJEgavAlmhjCO2/Qvf kvAB6gxLVhG8w2PcBuTg5caHL4V/nud0eDtLKBUfvbPira4CvDQ1HcrcHevh1DzdWAAl WPFdbkQcHhCwBjQa0LJcTsJv/h6PAep4S0z/TBBd+XvsW1hXXZnW2nBmHEvr7c/xi1Nr OThvF4VXi4nGk1ySTjCUUPTPlv/jjGgrsjIHRYz6Pu1/8zJhqiSBr0hgkHvnA+GZ+wDL tq6g== X-Gm-Message-State: AEkooutqck3Q2a8TSAu4tXb+awWI9P8mU7VgQiJWyuUlSuu59OEovM1xroSvE9XSPE0JpO/7aD4= X-Received: by 10.55.25.81 with SMTP id k78mr2673499qkh.93.1471529394083; Thu, 18 Aug 2016 07:09:54 -0700 (PDT) Received: from localhost (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id m4sm1129476qkf.29.2016.08.18.07.09.53 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 18 Aug 2016 07:09:53 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Thu, 18 Aug 2016 10:09:50 -0400 Message-Id: <1471529390-26282-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.7.4 X-Topics: patch Subject: [lng-odp] [PATCH v3] doc: release-guide: add LTS details X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Signed-off-by: Mike Holmes --- v3: use "non-embedded environments" (bill) doc/process-guide/release-guide.adoc | 52 ++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) -- 2.7.4 Reviewed-by: Bill Fischofer diff --git a/doc/process-guide/release-guide.adoc b/doc/process-guide/release-guide.adoc index 788eb6b..8ea147a 100644 --- a/doc/process-guide/release-guide.adoc +++ b/doc/process-guide/release-guide.adoc @@ -83,6 +83,7 @@ repository. All patches are acknowledged on the list as soon as they have been applied to the repository. +No patch may be accepted that knowingly breaks git bisect. === api-next === * api-next is always rebased on top of master when there is a release point in @@ -115,6 +116,57 @@ atomically as possible * the maintainer updates the version number * the maintainer tags the master branch +=== Long Term Support (LTS) +ODP is portable at two levels, at a recompiled common API level for maximum +performance, and in a more portable way at an ABI level which may sacrifice +some performance. + +==== odp-linux API and APB compatibility +In the odp-linux case, the Linux Operating System (OS) provides a mechanism for +ensuring ABI compatibility with the .so naming for shared libraries. This OS +specific number provides different definitions for the digits to the ODP API +version definition and will likely differ. Other OS'es may use other schemes. + +==== Vendor implementations +Vendors of ODP are said to be compatible with the ODP API if the implementation +can pass the validation test suite for the API. This means that supporting the +ABI mode is not required; a statically built and executed test suite is all that +is required. + +==== API compatibility +ODP allows implementations of the API to modify the structures. In this case +application portability is maintained through access functions to the data rather +than direct structure access. In an embedded use case this allows maximum +performance with the hardware structures mapping directly to the data structures +manipulated by the CPU. Applications are compiled for the target +system directly and are usually statically linked. + +==== ABI compatibility +In non-embedded environments where a possible performance penalty can be more +acceptable a shared library is likely to be used and it must maintain ABI +compatibility across that architecture. In this case applications do not require +recompiling. + +===== Checking which .so version number is required on change +To determine if the .so number should be changed the check-odp tool can provide +the answer. This tool provides a command line summary and a detailed html +analysis. This tool is based on the abi-compliance-checker + +[source,bash] +---- +COMPARE_BRANCH=monarch_lts ./diff-abi.sh + +... +preparation, please wait ... +comparing ABIs ... +comparing APIs ... +creating compatibility report ... +result: COMPATIBLE +total "Binary" compatibility problems: 0, warnings: 0 +total "Source" compatibility problems: 0, warnings: 0 +.... +---- + == Releases == All releases are from a tag in the master branch of the ODP git repository. Recall that ODP consists of three separate components: