From patchwork Mon Sep 29 18:24:56 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 38087 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f197.google.com (mail-lb0-f197.google.com [209.85.217.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 71F26201F1 for ; Mon, 29 Sep 2014 18:25:27 +0000 (UTC) Received: by mail-lb0-f197.google.com with SMTP id l4sf10527916lbv.0 for ; Mon, 29 Sep 2014 11:25:26 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:subject :precedence:list-id:list-unsubscribe:list-archive:list-post :list-help:list-subscribe:mime-version:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list :content-type:content-transfer-encoding; bh=h1yMljng6xLRxxGrKonfrdBqY78giNosO7M6qqyeH0c=; b=mDCqj1OGaARVUzovKIhzAChh6mPLlnSopMwy+6OjxOQ1dQb7bMcF2FT2B+HotFE2CQ N8eX9N2xLgqTc8so5TH3V4SphjdOwmE/Ca3rnb1r0G+SDU7KP7EIzrpYPZchNEjWKnrG NpfHP6fltBAzxm8lFqxQFYbjYjc0FwWz7uGeP42RI3DIF3vHDw86XhrhHapl3TJPVFow GMzRSvdHxxXv6CTJ7OE6VeCQp6y91K98Y2cnkE+OWZspq1zQIWDI06dOOWLiNlIZrvor RWUktzDWglOoNysWKattIDVGbsCrWHUBjTaUo+/VccVfenv8b1J5NeIvgRECqYruvfWI lxEQ== X-Gm-Message-State: ALoCoQmH8MDc/ZhB41PDR7bpSL9Bc2bVzrI6LBOdVxUCybENPAqMA7NA9YxUfH5KP3PAU2BoT4nh X-Received: by 10.194.249.134 with SMTP id yu6mr1191497wjc.1.1412015126185; Mon, 29 Sep 2014 11:25:26 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.23.72 with SMTP id k8ls464139laf.1.gmail; Mon, 29 Sep 2014 11:25:26 -0700 (PDT) X-Received: by 10.112.164.203 with SMTP id ys11mr39201942lbb.83.1412015126030; Mon, 29 Sep 2014 11:25:26 -0700 (PDT) Received: from mail-lb0-f174.google.com (mail-lb0-f174.google.com [209.85.217.174]) by mx.google.com with ESMTPS id zn3si10337673lbb.81.2014.09.29.11.25.25 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Mon, 29 Sep 2014 11:25:25 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.174 as permitted sender) client-ip=209.85.217.174; Received: by mail-lb0-f174.google.com with SMTP id l4so18400273lbv.19 for ; Mon, 29 Sep 2014 11:25:25 -0700 (PDT) X-Received: by 10.112.167.137 with SMTP id zo9mr10620913lbb.0.1412015125691; Mon, 29 Sep 2014 11:25:25 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.130.169 with SMTP id of9csp224232lbb; Mon, 29 Sep 2014 11:25:24 -0700 (PDT) X-Received: by 10.229.219.65 with SMTP id ht1mr26118902qcb.2.1412015124260; Mon, 29 Sep 2014 11:25:24 -0700 (PDT) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id n11si2007482qaa.108.2014.09.29.11.25.23 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 29 Sep 2014 11:25:24 -0700 (PDT) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XYfdR-0007M4-Lt; Mon, 29 Sep 2014 18:25:21 +0000 Received: from mail-qa0-f49.google.com ([209.85.216.49]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XYfdL-0007Lz-RP for lng-odp@lists.linaro.org; Mon, 29 Sep 2014 18:25:15 +0000 Received: by mail-qa0-f49.google.com with SMTP id n8so9101615qaq.8 for ; Mon, 29 Sep 2014 11:25:10 -0700 (PDT) X-Received: by 10.140.98.197 with SMTP id o63mr14710292qge.78.1412015109653; Mon, 29 Sep 2014 11:25:09 -0700 (PDT) Received: from fedora1.holmesfamily.ws ([98.221.136.245]) by mx.google.com with ESMTPSA id m8sm11835977qag.25.2014.09.29.11.25.08 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 29 Sep 2014 11:25:09 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Mon, 29 Sep 2014 14:24:56 -0400 Message-Id: <1412015096-62424-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: Architecture patch Subject: [lng-odp] [ARCH PATCH v3] Add release management X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: mike.holmes@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.174 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Mike Holmes Reviewed-by: Stuart Haslam --- release.dox | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 release.dox diff --git a/release.dox b/release.dox new file mode 100644 index 0000000..53301ac --- /dev/null +++ b/release.dox @@ -0,0 +1,54 @@ +/* Copyright (c) 2014, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** +@page release Release Management +@tableofcontents +@section release_numbering Numbering + +The API uses a three digit release number, for ODP this number refers to +- The API header definitions +- The reference implementation (linux-generic) +- The documentation +- The API test & validation suite that certifies each of the above. + +The header file odp_version.h contains helper macros for dealing with ODP versions in application code. + +@note The version refers to API source compatibility and not binary compatibility. +Every change in API version will require a recompilation, relinking will not be sufficient. + +The ODP API major.minor version will only change at well-defined release points. +A release will be tagged @code ODP-. @endcode and bug fix releases on the platform will be tagged @code ODP-.. @endcode first bug fix release sub = 1. + +@subsection major Major +The major digit is the ODP API generation. +A change to this digit indicates a break in backwards compatibility. +@note The incompatibility covers the whole ODP API, however the change may be a tiny change to an esoteric function that is not used by a given application. + +- Altering API signature +- Altering a structure other than adding optional items at the end. +- Changing the required calling sequence for APIs +- Changes to the installed structure i.e. the output from "make install" moves a file in a way that breaks compilation. +- New element to an enum that is an output from ODP + +@subsection minor Minor +The minor digit is for changes that are backwards compatible. +For example changes such as the addition of a new API. +Existing application code shall not have to change if the new API is not used. +- Adding a new struct +- Adding a new function +- Adding an additional alternate API to an existing one. +- New element to an enum that is an input to ODP + +@subsection sub Sub +The sub digit is used for backward compatible changes +Any existing app should work as before with the caveat that a bug fix may change the executable behavior (hopefully improve it) +- Optimize the implementation +- Documentation updates +- bug fixes in implementation + + +*/