From patchwork Tue Aug 9 23:56:42 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 73593 Delivered-To: patch@linaro.org Received: by 10.140.29.52 with SMTP id a49csp136850qga; Tue, 9 Aug 2016 16:56:56 -0700 (PDT) X-Received: by 10.237.59.79 with SMTP id q15mr1136054qte.77.1470787016100; Tue, 09 Aug 2016 16:56:56 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id x35si25213146qtd.43.2016.08.09.16.56.55; Tue, 09 Aug 2016 16:56:56 -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 3A8B2619AD; Tue, 9 Aug 2016 23:56:55 +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 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 1AB756069A; Tue, 9 Aug 2016 23:56:49 +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 0D3596069B; Tue, 9 Aug 2016 23:56:47 +0000 (UTC) Received: from mail-oi0-f45.google.com (mail-oi0-f45.google.com [209.85.218.45]) by lists.linaro.org (Postfix) with ESMTPS id EFF2E60699 for ; Tue, 9 Aug 2016 23:56:45 +0000 (UTC) Received: by mail-oi0-f45.google.com with SMTP id c15so39214474oig.0 for ; Tue, 09 Aug 2016 16:56:45 -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=Cnigxg3wMDKV2s6HTMXUpIIkdHNAvNuH7t0J/VHlZlU=; b=QxMf4XR+xvPiouCKeHPaaCW2PnXvM9xzNO+flB1YrTRswyyvyGN74J9mC46wEuo5AR MfOXVqj7PbTVPVPbTnxv+wwCkoIWnnGpCVFkYXx0uOoIHuFxTEFzFpbcAZ/+VBdCcmLH P1++HPJrvL5AhHu1UQPr6UAYJkzvhy0k2yE7QYx5ArDfMEgVzWFNEj0kudO5koW0ZR66 8MdlAut1v6DB1YCJUlC0TFAr8UFWVAiJjgUS7g+FjZkNscucTSabiqheKDE7qXbe7tuo GxOohjLocdjzf8Bte7M15RCQ/L+EKXLiyCN7JLPtXpYAd58g1zg5LYSkhxzjAtMJF10R asQw== X-Gm-Message-State: AEkooutHUlKi6t6DhT7/5jH5bO7s5YLLiJGlRkcaqm8Ctm5FHhh7JtWyvU4qsbsxc8sLwehD/dQ= X-Received: by 10.157.60.253 with SMTP id t58mr575201otf.45.1470787005169; Tue, 09 Aug 2016 16:56:45 -0700 (PDT) Received: from localhost.localdomain (cpe-66-68-129-43.austin.res.rr.com. [66.68.129.43]) by smtp.gmail.com with ESMTPSA id f10sm4540094otb.41.2016.08.09.16.56.44 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 09 Aug 2016 16:56:44 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 9 Aug 2016 18:56:42 -0500 Message-Id: <1470787002-1689-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 X-Topics: patch Subject: [lng-odp] [PATCHv3] doc: release-guide: elaborate release naming scheme 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" Add additional detail and examples to the description of the release naming scheme used by ODP, detailing the expected impact to ODP applications and/or other ODP implementations for each change. Signed-off-by: Bill Fischofer --- doc/process-guide/release-guide.adoc | 84 +++++++++++++++++++++++++++++------- 1 file changed, 69 insertions(+), 15 deletions(-) -- 2.7.4 diff --git a/doc/process-guide/release-guide.adoc b/doc/process-guide/release-guide.adoc index 8816c03..788eb6b 100644 --- a/doc/process-guide/release-guide.adoc +++ b/doc/process-guide/release-guide.adoc @@ -116,28 +116,82 @@ atomically as possible * the maintainer tags the master branch == Releases == -All releases are from master. - -They are tagged in the repository using the format -v... -There are three release types with differing frequencies and impact to the -applications. +All releases are from a tag in the master branch of the ODP git +repository. Recall that ODP consists of three separate components: + +* An API Specification +* Multiple independently owned and maintained _implementations_ of the ODP API +* A Validation Test Suite that tests implementation conformance to the ODP API + +Included with the main ODP git repository is the `odp-linux` reference +implementation of the ODP API, and it also has an associated service stream +that is independent of all other ODP implementations. This means that the ODP +release naming conventions address the needs of all three of these components, +which is accomplished via a multi-level structure using the format: + +*v...* + +This is used as the tag from which all ODP releases are published and is also +used as the release identifier in the CHANGELOG for each release. The first +three of these digits represent the ODP API level, and these reflect three +types of API changes with differing frequencies and impact to applications and +other ODP implementations. A fourth digit is used to reflect changes to other +items included within the ODP git repository. In addition, each individual ODP +implementation will have its own service stream identifier that is defined +using whatever conventions meet its needs. === Generation releases === A generation release indicates a major completion of work, and a possible -change in direction for the API. Same as for Major release plus they are -defined by the Steering committee. +change in direction for the API. Generation release changes are approved by the +LNG Steering Committee, which is the governing body for ODP. === Major releases === -Major (API) releases are scheduled to be about once a -quarter, but when there is significant progress made they may be more frequent. +Major (API) releases are used when new APIs or capabilities are introduced or +changes are made to existing APIs that are not backwards-compatible. Major +release changes thus potentially affect ODP applications as well as +implementations. + +=== Minor releases === +Minor (API) releases are used when new APIs or capabilities are introduced or +changes are made to existing APIs in a backwards-compatible manner. Examples +of these might be wording changes in API documentation, or introducing new +APIs that are orthogonal to the existing set of APIs and hence have no impact +on existing applications that do not make use of them. Minor release changes +should therefore have no impact on existing ODP applications but will have +impact for ODP implementations that need to support these API additions and +changes. + +NOTE: The first three digits of the release name are the API version returned +by the `odp_version_api_str()` API. === Point releases === -General bug fixes and other non API altering changes are gathered and a release -made every month if sufficient change has accumulated. - -=== Implementation (Impl) === -Platform specific free form text relating to the version. +General bug fixes and other non API altering changes are gathered and a +release made every month if sufficient change has accumulated. Examples of a +point release would be additional documentation, extensions or corrections to +the validation test suite, additions or corrections to helpers, example +programs, etc. No API changes are permitted in a point release, so ODP +applications are not impacted. Other ODP implementations _may_ be impacted +if, for example, a bug is fixed in a validation test that results in a latent +bug in other implementations being exposed. + +=== Implementation Service Strings === +Beyond the four-digit release name, platform specific free form text is used +to capture the service level of each ODP implementation. This field is for the +sole use of implementations to represent their individual service streams. Its +format may vary between implementations. For example, the `odp-linux` +reference implementation uses a simple incrementing digit (0, 1, 2, +etc.). Other implementations may use `Build xxxx` or something similar. +Changes in this designator have no impact on and may be ignored by other ODP +implementations. The only changes that ODP applications should see is +corrected functional or performance behavior when running on that specific ODP +implementation. + +NOTE: The full four-digit release name plus implementation service string as +well as other platform-specific identification information is returned by the +`odp_version_impl_str()` API. This may be useful, for example, in logging an +error to include in a bug report to the vendor that owns and supports this ODP +implementation. The release-independent name of a given implementation (for +identification purposed) is supplied by the `odp_version_impl_name()` API. == Deprecating part of the API Deleting or changing the published API follows the normal <>, with the following additional rules: