From patchwork Fri Sep 26 16:04:11 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 38009 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f199.google.com (mail-wi0-f199.google.com [209.85.212.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 3302B20F2E for ; Fri, 26 Sep 2014 16:04:38 +0000 (UTC) Received: by mail-wi0-f199.google.com with SMTP id hi2sf5882006wib.10 for ; Fri, 26 Sep 2014 09:04:37 -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=z4NNumMVoIUx8BkUq1DWkpcnQt9kIP0dWBq1pw7VVME=; b=UUWwcPFHHD6mOCwyGliINmRo+u6XX8bjtV7tVhvsKIlT87bYFXGz+2G9C9HxN2eKqy FBtKdB9/WOK1CKbe9u697iAplyyYPuLuaY6JKU3KXFZYW9HlKaY8krvN5ZpTSjA7t/dm eL8DrEVhinFRKbKeONdEMFxBZJOPeCkV+Y7dSZh48F8/6aBD3HZyBZj9qN/se/uHBBj5 83O/RuafEJtYYTYwNs79URSaf7wiqSSSgezqpJ/GqVZd0h5cGZzCLZicpmHtVdKUsw+C 2SDpncn/CjCJBbzBGI8YfQvRpryZ9Y99h7nz/kuKodDRVi/tmsL16i/nCSntuCPap2vG ctAw== X-Gm-Message-State: ALoCoQnaDQACqcgFB3pu1aSEAwSJF1j1GAOMJn35agxtyTxhYuXSwVX53umSysVOmelVcgEu172/ X-Received: by 10.180.24.225 with SMTP id x1mr6310483wif.2.1411747477413; Fri, 26 Sep 2014 09:04:37 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.204.99 with SMTP id kx3ls418556lac.7.gmail; Fri, 26 Sep 2014 09:04:37 -0700 (PDT) X-Received: by 10.152.8.9 with SMTP id n9mr21526693laa.2.1411747477257; Fri, 26 Sep 2014 09:04:37 -0700 (PDT) Received: from mail-la0-f48.google.com (mail-la0-f48.google.com [209.85.215.48]) by mx.google.com with ESMTPS id wq3si7840091lbb.23.2014.09.26.09.04.37 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Fri, 26 Sep 2014 09:04:37 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.48 as permitted sender) client-ip=209.85.215.48; Received: by mail-la0-f48.google.com with SMTP id q1so3164364lam.35 for ; Fri, 26 Sep 2014 09:04:37 -0700 (PDT) X-Received: by 10.152.5.168 with SMTP id t8mr20953672lat.67.1411747476943; Fri, 26 Sep 2014 09:04:36 -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 of9csp86967lbb; Fri, 26 Sep 2014 09:04:36 -0700 (PDT) X-Received: by 10.140.95.237 with SMTP id i100mr35353731qge.6.1411747475193; Fri, 26 Sep 2014 09:04:35 -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 b2si6379434qgf.10.2014.09.26.09.04.34 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Fri, 26 Sep 2014 09:04:35 -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 1XXY0W-0005K4-PV; Fri, 26 Sep 2014 16:04:32 +0000 Received: from mail-qa0-f44.google.com ([209.85.216.44]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XXY0Q-0005Jz-CK for lng-odp@lists.linaro.org; Fri, 26 Sep 2014 16:04:26 +0000 Received: by mail-qa0-f44.google.com with SMTP id x12so6408486qac.31 for ; Fri, 26 Sep 2014 09:04:21 -0700 (PDT) X-Received: by 10.140.101.118 with SMTP id t109mr34138467qge.101.1411747460306; Fri, 26 Sep 2014 09:04:20 -0700 (PDT) Received: from fedora1.holmesfamily.ws ([98.221.136.245]) by mx.google.com with ESMTPSA id z8sm1010962qaj.43.2014.09.26.09.04.19 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 26 Sep 2014 09:04:19 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Fri, 26 Sep 2014 12:04:11 -0400 Message-Id: <1411747451-5127-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.215.48 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: Anders Roxell --- v3: Spelling V2: Add a note to the Major section to highlight that although the API is now backwards incompatible, the change may be inconsequential to a given application. Fix copyright date. release.dox | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 release.dox diff --git a/release.dox b/release.dox new file mode 100644 index 0000000..7caa662 --- /dev/null +++ b/release.dox @@ -0,0 +1,48 @@ +/* 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 suit that certifies the headers and documentation. + +The ODP API major.minor version will only change at well-defined release points. +A release will be tagged ODP-. and bug fix releases on the platform will be tagged ODP-.. first bug fix release sub = 1. + +@subsection major Major +The major digit is the ODP API generation. +A change to this digit will break 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 +- Changing the required calling sequence for APIs +- Changes to the installed structure +- 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 + +*/