From patchwork Wed Apr 22 17:12:59 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 47424 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 E2CED2121F for ; Wed, 22 Apr 2015 17:13:19 +0000 (UTC) Received: by wicmx19 with SMTP id mx19sf13453720wic.3 for ; Wed, 22 Apr 2015 10:13:19 -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=dUcI5WmGrayx376Tg4fQ4hJ/MPJfPKzHKGdhm/OhxIQ=; b=FXBnP1BT50oLpHtjWZ919pjP9vw/WMJTbu1tsS3OtBHTRH9zbmyFuYJEg8BS4pzGvE JHbKcJx+WMt/Edno+VjXI32ikeI2tioiT9Lh+Y1vB7nENqS5mZNzIuYjGaCvdixNCDd5 KGuXSWzpakmUoq7OaqQIHiYoPGCHuc2VbIwUSokqytNmQAdXp7t2VNUeX5bcaUbfI8SM KGGwq10pZMsNkzig78b33spN4r4zotlg/NwYi7gD8x6ZCWNDwY9ctivOeOEu09tWbdIm GFm0o5zbyMUe06UD8stQDkF5lCRnjm+x3BE8HeGE4G2jRGGSKFxLhmb1TNkjI/31R8nU 70hw== X-Gm-Message-State: ALoCoQmdYQ/JA0cKr2DG2UTqQ6Jy1TQpN5W3d2F/YDzOwGWqWo6/vAoHW6x2xDpCg7rI6MWDU5J3 X-Received: by 10.180.106.136 with SMTP id gu8mr1905282wib.6.1429722799191; Wed, 22 Apr 2015 10:13:19 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.2.9 with SMTP id 9ls260025laq.89.gmail; Wed, 22 Apr 2015 10:13:18 -0700 (PDT) X-Received: by 10.112.16.42 with SMTP id c10mr4438544lbd.103.1429722798970; Wed, 22 Apr 2015 10:13:18 -0700 (PDT) Received: from mail-lb0-f169.google.com (mail-lb0-f169.google.com. [209.85.217.169]) by mx.google.com with ESMTPS id js14si4132012lab.166.2015.04.22.10.13.18 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 22 Apr 2015 10:13:18 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.169 as permitted sender) client-ip=209.85.217.169; Received: by lbbuc2 with SMTP id uc2so185381457lbb.2 for ; Wed, 22 Apr 2015 10:13:18 -0700 (PDT) X-Received: by 10.152.26.34 with SMTP id i2mr25143487lag.117.1429722798878; Wed, 22 Apr 2015 10:13:18 -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 l1csp69333lbt; Wed, 22 Apr 2015 10:13:17 -0700 (PDT) X-Received: by 10.140.236.77 with SMTP id h74mr31712807qhc.21.1429722796753; Wed, 22 Apr 2015 10:13:16 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id b125si5591263qhc.126.2015.04.22.10.13.12; Wed, 22 Apr 2015 10:13:16 -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 50F8761F4A; Wed, 22 Apr 2015 17:13:12 +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_H2, 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 CA72F61D27; Wed, 22 Apr 2015 17:13:08 +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 30D6E61ED7; Wed, 22 Apr 2015 17:13:07 +0000 (UTC) Received: from mail-qg0-f49.google.com (mail-qg0-f49.google.com [209.85.192.49]) by lists.linaro.org (Postfix) with ESMTPS id C0DA261D27 for ; Wed, 22 Apr 2015 17:13:06 +0000 (UTC) Received: by qgeb100 with SMTP id b100so86718578qge.3 for ; Wed, 22 Apr 2015 10:13:06 -0700 (PDT) X-Received: by 10.140.233.76 with SMTP id e73mr32129143qhc.96.1429722786442; Wed, 22 Apr 2015 10:13:06 -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 5sm4080237qgg.28.2015.04.22.10.13.05 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 22 Apr 2015 10:13:05 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Wed, 22 Apr 2015 13:12:59 -0400 Message-Id: <1429722779-24130-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 v2] 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.217.169 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: Bill Fischofer --- v2 add doxygen description doc/api_guide_lines.dox | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox index 2bc63a1..0832cae 100644 --- a/doc/api_guide_lines.dox +++ b/doc/api_guide_lines.dox @@ -187,6 +187,11 @@ 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. +A deprecated API will contain the doxygen tag \@deprecated with a description of the reason for the change. + @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.