From patchwork Fri Sep 26 15:23:23 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 38006 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f72.google.com (mail-wg0-f72.google.com [74.125.82.72]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 063E220F2E for ; Fri, 26 Sep 2014 15:23:46 +0000 (UTC) Received: by mail-wg0-f72.google.com with SMTP id k14sf4070633wgh.11 for ; Fri, 26 Sep 2014 08:23:46 -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=aEKS2MGxZVgfMQGemk2iy4wUJzztNms0FcSEOidZvck=; b=RFOBjIVCDPwIpi83IbkqcqSEu4RlHenF44PysegSITGtvL+6DJivtCcMe/y0nKBQVp xkeMCMHqdaKdZ1ZBnq7ICuz4ouEcwI/Zm/ewGWUpmRRNg/WO8ZtJfSqjdAe+AmcgFEqX GeDVhvJDxiUYWt6UjYkvfhRaveo3MpPICt/wURaEHMtkRv6jjOpNYcWzEl9AKH+U2IC4 FrfBuwAthPDi4/PMUoKH47qQALnN+tqvKfDAgF7vNCTostLF9PwvN85rt1PspXOgUaVG s8fzXkwE8TX8rg/0ofLDJDcVuqdlvtZxzqizjmS52AjX2a9RVuGlUnKy2oPAqiRrXPj7 fdLQ== X-Gm-Message-State: ALoCoQks0jLRbstKGB0zcR4D0Jd//ohb7+vRo3d4qN9uP996tvN56pMIRlct1elyAttLUxnLFRXg X-Received: by 10.152.1.4 with SMTP id 4mr77072lai.9.1411745026211; Fri, 26 Sep 2014 08:23:46 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.161.225 with SMTP id xv1ls392826lab.43.gmail; Fri, 26 Sep 2014 08:23:46 -0700 (PDT) X-Received: by 10.152.21.195 with SMTP id x3mr21110300lae.11.1411745026106; Fri, 26 Sep 2014 08:23:46 -0700 (PDT) Received: from mail-lb0-f175.google.com (mail-lb0-f175.google.com [209.85.217.175]) by mx.google.com with ESMTPS id zu10si7601869lbb.80.2014.09.26.08.23.45 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Fri, 26 Sep 2014 08:23:45 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.175 as permitted sender) client-ip=209.85.217.175; Received: by mail-lb0-f175.google.com with SMTP id w7so9195496lbi.34 for ; Fri, 26 Sep 2014 08:23:45 -0700 (PDT) X-Received: by 10.112.130.226 with SMTP id oh2mr3597135lbb.100.1411745025753; Fri, 26 Sep 2014 08:23:45 -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 of9csp80931lbb; Fri, 26 Sep 2014 08:23:44 -0700 (PDT) X-Received: by 10.224.127.131 with SMTP id g3mr14007650qas.81.1411745024152; Fri, 26 Sep 2014 08:23:44 -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 u7si6226299qcq.28.2014.09.26.08.23.43 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Fri, 26 Sep 2014 08:23:44 -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 1XXXN0-0004GK-6L; Fri, 26 Sep 2014 15:23:42 +0000 Received: from mail-qg0-f46.google.com ([209.85.192.46]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XXXMt-0004FZ-Tq for lng-odp@lists.linaro.org; Fri, 26 Sep 2014 15:23:35 +0000 Received: by mail-qg0-f46.google.com with SMTP id q108so9168673qgd.5 for ; Fri, 26 Sep 2014 08:23:30 -0700 (PDT) X-Received: by 10.224.73.132 with SMTP id q4mr30778003qaj.78.1411745010495; Fri, 26 Sep 2014 08:23:30 -0700 (PDT) Received: from fedora1.holmesfamily.ws ([98.221.136.245]) by mx.google.com with ESMTPSA id o6sm4859374qag.40.2014.09.26.08.23.29 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 26 Sep 2014 08:23:29 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Fri, 26 Sep 2014 11:23:23 -0400 Message-Id: <1411745003-4448-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: patch Subject: [lng-odp] [PATCH v2] 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.175 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 --- V2: Add a note to the Majori section to highlight that although the API is now bacwards incompatible, the change may be inconsequential to a given applicaion. 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 refreence 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 incompatibilty covers the whole ODP API, however the change may be a tiny change to an esoteric function that is not used by a given applicaion. + +- 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 + +*/