From patchwork Thu Sep 25 21:07:47 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 37935 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f199.google.com (mail-lb0-f199.google.com [209.85.217.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 8918D20560 for ; Thu, 25 Sep 2014 21:08:13 +0000 (UTC) Received: by mail-lb0-f199.google.com with SMTP id z12sf4498548lbi.2 for ; Thu, 25 Sep 2014 14:08:12 -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=6f0o9fZd1tuiid6v2YKY7aLqsdaaagcrGUoGJE/Ga6s=; b=WzUxEt1JsmVaqFxTNd6FGPIzdCcOjCGlf41h8wVvaPF86mpboTqKSqq1QywAQircpC Kt4Fi34vMK3p1dw8DdYvK83XInOtlGCykKomy0AzJC7hUOZYfuwRhWEIQBmmF4tisTFZ wSovHMcrPNhJywPCLNjUI8lGhuGcwyqoP7ve6QNrpyuZjxA81jiF45BnW2l6P+6nkRKA RXnON9UM6eNq3f6w8hjQh12MrdAV9Aa0Lyz4MSbTj+r/8oOzhVbC0ISWL2H0k63v5+eL k/99/38Gmz7OGTiJfLuNnU54eRrXxPBA2PMwcHMNMl1AkC+hbQXQrNYBeQdqXwEh9C43 eK3g== X-Gm-Message-State: ALoCoQmBv+W614PvS0B/qx6wW/3KC1h/IPSVlfuhkU/cjnJ+xWel2r1BUhr/ws9hUBGBIYx00a9Z X-Received: by 10.180.88.8 with SMTP id bc8mr2946500wib.0.1411679292278; Thu, 25 Sep 2014 14:08:12 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.153.6.38 with SMTP id cr6ls283441lad.17.gmail; Thu, 25 Sep 2014 14:08:12 -0700 (PDT) X-Received: by 10.152.7.145 with SMTP id j17mr15674960laa.77.1411679292058; Thu, 25 Sep 2014 14:08:12 -0700 (PDT) Received: from mail-lb0-f179.google.com (mail-lb0-f179.google.com [209.85.217.179]) by mx.google.com with ESMTPS id xl9si4648651lbb.58.2014.09.25.14.08.11 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 25 Sep 2014 14:08:11 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.179 as permitted sender) client-ip=209.85.217.179; Received: by mail-lb0-f179.google.com with SMTP id 10so12631040lbg.38 for ; Thu, 25 Sep 2014 14:08:11 -0700 (PDT) X-Received: by 10.112.75.233 with SMTP id f9mr5409295lbw.102.1411679291705; Thu, 25 Sep 2014 14:08:11 -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 of9csp825541lbb; Thu, 25 Sep 2014 14:08:11 -0700 (PDT) X-Received: by 10.140.21.85 with SMTP id 79mr25386565qgk.69.1411679290432; Thu, 25 Sep 2014 14:08:10 -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 y8si3831889qci.49.2014.09.25.14.08.09 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 25 Sep 2014 14:08:10 -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 1XXGGm-0002hq-Dd; Thu, 25 Sep 2014 21:08:08 +0000 Received: from mail-qa0-f52.google.com ([209.85.216.52]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XXGGg-0002hl-RN for lng-odp@lists.linaro.org; Thu, 25 Sep 2014 21:08:02 +0000 Received: by mail-qa0-f52.google.com with SMTP id dc16so5216788qab.39 for ; Thu, 25 Sep 2014 14:07:57 -0700 (PDT) X-Received: by 10.224.135.132 with SMTP id n4mr22515853qat.27.1411679277569; Thu, 25 Sep 2014 14:07:57 -0700 (PDT) Received: from fedora1.holmesfamily.ws ([98.221.136.245]) by mx.google.com with ESMTPSA id h2sm3007481qah.35.2014.09.25.14.07.56 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 25 Sep 2014 14:07:56 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Thu, 25 Sep 2014 17:07:47 -0400 Message-Id: <1411679267-19504-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] 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.179 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 --- release.dox | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 release.dox diff --git a/release.dox b/release.dox new file mode 100644 index 0000000..28d1b01 --- /dev/null +++ b/release.dox @@ -0,0 +1,46 @@ +/* Copyright (c) 2013, 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. +It would be used generally to indicate backward incompatibility, a change to this digit will break backwards compatibility +- 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 application 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 + +*/