From patchwork Tue Dec 15 18:06:06 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 58450 Delivered-To: patch@linaro.org Received: by 10.112.89.199 with SMTP id bq7csp204156lbb; Tue, 15 Dec 2015 10:07:38 -0800 (PST) X-Received: by 10.141.0.194 with SMTP id b185mr46577625qhd.23.1450202858715; Tue, 15 Dec 2015 10:07:38 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id h76si365654qhc.78.2015.12.15.10.07.38; Tue, 15 Dec 2015 10:07:38 -0800 (PST) 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; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dkim=neutral (body hash did not verify) header.i=@linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 3CF8261B1A; Tue, 15 Dec 2015 18:07:38 +0000 (UTC) Authentication-Results: lists.linaro.org; dkim=fail reason="verification failed; unprotected key" header.d=linaro.org header.i=@linaro.org header.b=Bq6BWFuw; dkim-adsp=none (unprotected policy); dkim-atps=neutral X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-2.5 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_LOW,RCVD_IN_MSPIKE_H2,T_DKIM_INVALID,URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 894E961B53; Tue, 15 Dec 2015 18:06:41 +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 73B2E61565; Tue, 15 Dec 2015 18:06:24 +0000 (UTC) Received: from mail-qg0-f46.google.com (mail-qg0-f46.google.com [209.85.192.46]) by lists.linaro.org (Postfix) with ESMTPS id DD3CD61565 for ; Tue, 15 Dec 2015 18:06:21 +0000 (UTC) Received: by mail-qg0-f46.google.com with SMTP id i91so6310201qgf.2 for ; Tue, 15 Dec 2015 10:06:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=dDIh+711dotUlbXE/zGU9ts4gZt4dtHmD/rij41nYGY=; b=Bq6BWFuwoj/YwSHGSclz/xu7aKHwqTGV6e15BLQlCQILw/Liq2R7qptKJ94+3iN4gq P5FI1Uk7ajRwBp9MQ1uAAz3yV62opws7dU3UGaEKbNChTCaYfQsaDBt21SMwlSpUDwD6 e6BXySWwnCAIenI0c5g3XOxKwxws8dx8hYF08= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=dDIh+711dotUlbXE/zGU9ts4gZt4dtHmD/rij41nYGY=; b=ZRUzQhQLJ7HQEv380qYJ8b2VP5QCHu5cIGKnmna85CeFgHEHSnea7GpZ4f4GXskHsN 2mUx3QCprq6leGzJ6mbfzPTfet72CkSzIc7Sb9uQR1QRw0sQ6K07QZyLv9fsvXGrlqmI 4f00fK1H/RBQbgHQlXkKCjJa++4ZdmFmqQcYP9Krql9XgU1yUqsSLCoY8LxL6w4VNw8k atF6XxlKCnD2CCLtAoLvUrOahuQdgEXtAq1iioEEkjzs0r/44YVw9mfsIEho7SColSz0 YWgx5y5RNnWWoHcnR/hFiBl6ySS+E4cs6FCGpypQhzcoGaE+aqRqI6fDZO7xxfC6+Ql9 lIUA== X-Gm-Message-State: ALoCoQl56OUMaTulv+oZ3qbV7apl0SBjjUZM/Y997Xn9bTfIE7OJ508ZkFEuMUPV3F6MUx/pwe1GoGULZWxsGzCOvJU3j/Q3Mw== X-Received: by 10.140.144.205 with SMTP id 196mr46506585qhq.38.1450202781630; Tue, 15 Dec 2015 10:06:21 -0800 (PST) Received: from localhost.localdomain (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id d9sm948287qhc.25.2015.12.15.10.06.20 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 15 Dec 2015 10:06:21 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Tue, 15 Dec 2015 13:06:06 -0500 Message-Id: <1450202766-30096-3-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.5.0 In-Reply-To: <1450202766-30096-1-git-send-email-mike.holmes@linaro.org> References: <1450202766-30096-1-git-send-email-mike.holmes@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCH 2/2] doc: release-guide: add deprecated api section X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" 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" Describe how changes to the public api are handled from release to release. Signed-off-by: Mike Holmes --- doc/process-guide/release-guide.adoc | 38 ++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/doc/process-guide/release-guide.adoc b/doc/process-guide/release-guide.adoc index f5d29d2..d932118 100644 --- a/doc/process-guide/release-guide.adoc +++ b/doc/process-guide/release-guide.adoc @@ -134,3 +134,41 @@ made every month if sufficient change has accumulated. === Implementation (Impl) === Platform specific free form text relating to the version. + +== Deprecated APIs + +Whenever an API is changed as part of an api-next patch the following rules +apply to provide a warning to implementers and users. + +* A patch will be applied to api-next that adds the deprecated indication to +the old public API in odp/include +* A patch will be applied to api-next that adds the new API and removes the +old, in these cases the implementation and tests must also change at the same +time to ensure that CI shows no regressions in the api-next branch. +* When the Release Manager has scheduled the api change to be released in a +future version, the initial deprecated patch will be moved to next branch and +released in the next release cycle. +* When at a minim of one release cycle has passed, and possibly longer as +specified by the Release Manager the complete change will be merged to next and +then released in the next cycle. + +NOTE: Any given release never supports two versions of an API + +.Marking a deprecated API element +[source,c] +---- +/** + * Get buffer handle from event + * + * Converts an ODP_EVENT_BUFFER type event to a buffer. + * + * @deprecated This api will be removed for some good reason defined here + * + * @param ev Event handle + * + * @return Buffer handle + * + * @see odp_event_type() + */ +odp_buffer_t odp_buffer_from_event(odp_event_t ev); +---- \ No newline at end of file