From patchwork Tue Apr 21 19:33:05 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 47402 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f200.google.com (mail-wi0-f200.google.com [209.85.212.200]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 17BD320553 for ; Tue, 21 Apr 2015 19:33:28 +0000 (UTC) Received: by wixv7 with SMTP id v7sf6960638wix.0 for ; Tue, 21 Apr 2015 12:33:27 -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:delivered-to:from:to:date :message-id:mime-version:subject:precedence:list-id:list-unsubscribe :list-archive:list-post:list-help:list-subscribe:content-type :content-transfer-encoding:errors-to:sender:x-original-sender :x-original-authentication-results:mailing-list; bh=BLP9C5+atKGVDhI5+82HA1CDRAC09sJBtGLXwvLoFIY=; b=DogBqKcbUfUfE/D1a9/ytgZ098uRAnzAdJb7W4L7ZdxSkR4y+aQUBEVrUS6ZZlG5Ag yo6Kz+OMyxvhbE//adse18N4yQafrBASktZsWDjv34XyTrSsLZhzBch+wyb7imK6PPdX IvD/ZcyXRDd64bt3k+dH2noXKBd6wXMMQzqL6TGQEwdLHiU76Md073dH0hSM9+21xaRR s+ge/u0dJf8jp+csQPNyEnJToDAMQR6ZGz9iMH8hEOzBp1LgjdSJKuqSghDeZ1rODYjJ 32PLlpHUHZZghVRb9MNwXNAg/OoUOxzt8FWKeck0LGzjqaZWI3afLAkLzw/hxEejH3+Z lj+w== X-Gm-Message-State: ALoCoQk6tg99qXuDE5gbxjOXge5BSEGw+5pXocnjkbVy4e95OO/5ICHDZcUQmiynqmhFmTYag167 X-Received: by 10.112.151.146 with SMTP id uq18mr10089341lbb.20.1429644806962; Tue, 21 Apr 2015 12:33:26 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.27.194 with SMTP id v2ls111563lag.59.gmail; Tue, 21 Apr 2015 12:33:26 -0700 (PDT) X-Received: by 10.112.170.70 with SMTP id ak6mr8135968lbc.42.1429644806814; Tue, 21 Apr 2015 12:33:26 -0700 (PDT) Received: from mail-la0-f44.google.com (mail-la0-f44.google.com. [209.85.215.44]) by mx.google.com with ESMTPS id kp20si2069287lbb.109.2015.04.21.12.33.26 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 21 Apr 2015 12:33:26 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.44 as permitted sender) client-ip=209.85.215.44; Received: by layy10 with SMTP id y10so158987414lay.0 for ; Tue, 21 Apr 2015 12:33:26 -0700 (PDT) X-Received: by 10.152.8.78 with SMTP id p14mr21631676laa.19.1429644806205; Tue, 21 Apr 2015 12:33:26 -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.67.65 with SMTP id l1csp828835lbt; Tue, 21 Apr 2015 12:33:25 -0700 (PDT) X-Received: by 10.140.82.144 with SMTP id h16mr24785101qgd.29.1429644804732; Tue, 21 Apr 2015 12:33:24 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id b5si2852227qhc.70.2015.04.21.12.33.23; Tue, 21 Apr 2015 12:33:24 -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; Received: by lists.linaro.org (Postfix, from userid 109) id 4284861E76; Tue, 21 Apr 2015 19:33:23 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252.ec2.internal 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, URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from ip-10-142-244-252.ec2.internal (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 78E6361E53; Tue, 21 Apr 2015 19:33:20 +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 1E37A61E6E; Tue, 21 Apr 2015 19:33:13 +0000 (UTC) Received: from mail-qc0-f174.google.com (mail-qc0-f174.google.com [209.85.216.174]) by lists.linaro.org (Postfix) with ESMTPS id 6FD3261E5F for ; Tue, 21 Apr 2015 19:33:12 +0000 (UTC) Received: by qcyk17 with SMTP id k17so81771881qcy.1 for ; Tue, 21 Apr 2015 12:33:12 -0700 (PDT) X-Received: by 10.140.144.12 with SMTP id 12mr25970257qhq.72.1429644792085; Tue, 21 Apr 2015 12:33:12 -0700 (PDT) Received: from mike-desktop.?.holmesfamily.ws (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by mx.google.com with ESMTPSA id z69sm2007421qkz.27.2015.04.21.12.33.11 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 21 Apr 2015 12:33:11 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Tue, 21 Apr 2015 15:33:05 -0400 Message-Id: <1429644785-18264-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 MIME-Version: 1.0 X-Topics: patch Subject: [lng-odp] [PATCH] doc: api_guide_lines: add guidance on ODP_DEPRECATED X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" 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.44 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 --- doc/api_guide_lines.dox | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox index 2bc63a1..f26ce38 100644 --- a/doc/api_guide_lines.dox +++ b/doc/api_guide_lines.dox @@ -187,6 +187,10 @@ This is one of the reasons why some features MAY be defined as OPTIONAL. While allowed, the proliferation of OPTIONAL features SHOULD be avoided to enable broad application portability across many implementations. At the same time, a “least common denominator” approach MUST NOT be taken as that defeats the purpose of providing higher-level abstractions in APIs. +@subsection odp_deprecated ODP DEPRECATED +A deprecated API will remain marked as such in the public API using #ODP_DEPRECATED for two release cycles for the #ODP_VERSION_API_MAJOR number. +For example an API marked as deprecated in 1.1.0 will still be present in 1.2.0 and removed in 1.3.0 + @section defaults Default behaviours When an API has a default behaviour it must be possible for the application to explicitly call for that behaviour, this guards against the default changing and breaking the application.