From patchwork Mon Aug 8 15:34:56 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 73456 Delivered-To: patch@linaro.org Received: by 10.140.29.52 with SMTP id a49csp36912qga; Mon, 8 Aug 2016 08:35:19 -0700 (PDT) X-Received: by 10.55.27.106 with SMTP id b103mr27475511qkb.224.1470670519095; Mon, 08 Aug 2016 08:35:19 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id o4si17646870qkf.158.2016.08.08.08.35.18; Mon, 08 Aug 2016 08:35:19 -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 EF1D260F51; Mon, 8 Aug 2016 15:35:17 +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_H3, RCVD_IN_MSPIKE_WL, URIBL_BLOCKED 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 7C1F860F48; Mon, 8 Aug 2016 15:35:12 +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 2604D60F4D; Mon, 8 Aug 2016 15:35:10 +0000 (UTC) Received: from mail-qk0-f179.google.com (mail-qk0-f179.google.com [209.85.220.179]) by lists.linaro.org (Postfix) with ESMTPS id E681C60F47 for ; Mon, 8 Aug 2016 15:34:59 +0000 (UTC) Received: by mail-qk0-f179.google.com with SMTP id x185so132839391qkc.2 for ; Mon, 08 Aug 2016 08:34:59 -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=obXyYc9EMrhpgq5QsQA+U/C3IL0UrQIfEAtOgP0r6Xo=; b=QlCnBmi99VfrwsAol2SPTnD7+66H1uqjVF25sFv/1rHYgkBmoAGCIohVfI3/hPICr1 FKvHMZw9pPNxVuhKwRr0foNGY22LQfP4bHcGjQhANj27ZLMamUC8q9XPteNLartZ3eeG 9/jhDRDrmYRS/GA9BtKoaNYmf1Pql81EFMZi74j4ESJ3GubqHTg7EFQGgbS161EB1Uds 2EXFHrHTKpu5w+MVkclmCldSB3FbDYb0OIkbWXuGOKZcKoM0TFjsX0IwBAUUohAHRo+T WjNgAWwdlRqc7+HX6BYgMEf9nvHtV68i8eda3TRkg+2CRoOxN7PahGlH0HIVfZhsIxu6 dATA== X-Gm-Message-State: AEkoous3L4F9JynBG3SmiR42/3l6MwEBUMmtlUSwq4KGSTGzd99Fa1zlGX11EM19Lw80lv6P5iU= X-Received: by 10.55.81.68 with SMTP id f65mr5391686qkb.65.1470670499442; Mon, 08 Aug 2016 08:34:59 -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 t12sm16801488qke.5.2016.08.08.08.34.58 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 08 Aug 2016 08:34:58 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Mon, 8 Aug 2016 11:34:56 -0400 Message-Id: <1470670496-8651-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.7.4 X-Topics: patch Subject: [lng-odp] [PATCH] 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 --- doc/process-guide/release-guide.adoc | 53 ++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) -- 2.7.4 diff --git a/doc/process-guide/release-guide.adoc b/doc/process-guide/release-guide.adoc index 8816c03..c9b8484 100644 --- a/doc/process-guide/release-guide.adoc +++ b/doc/process-guide/release-guide.adoc @@ -115,6 +115,59 @@ 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 though access functions to the data rather +than direct structure access. In an embedded use case this allows the maximum +performance with the HW 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 a more traditional system where a performance penalty can be accepted to gain +portability 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. The penalty is that the implementation is probably having to +translate to the ABI from internal data representations. In some cases the +translation can also be done in hardware at little cost. + +===== 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 master.