From patchwork Fri Feb 27 17:36:29 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxim Uvarov X-Patchwork-Id: 45262 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f71.google.com (mail-la0-f71.google.com [209.85.215.71]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 6737B20674 for ; Fri, 27 Feb 2015 17:37:47 +0000 (UTC) Received: by labge10 with SMTP id ge10sf15474799lab.3 for ; Fri, 27 Feb 2015 09:37:46 -0800 (PST) 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:content-type :content-transfer-encoding:errors-to:sender:x-original-sender :x-original-authentication-results:mailing-list; bh=Q4heNI01r87zObTnmGXGoUdfCxp1S2Yw3gCO7rjXBV8=; b=jX2eAmuyxJkM0nDL5aB4pwez4xtSk5kxTAV+M6y333Cc1R+EXwtmrr+roWQM1W3DHQ kqkAoZd7CvqFxY436ce7mIpC5QTwPACbv2RPu7E38+8F/dOkDK8NlDFpIdlim8mbNEiE zplqZq3JpuWSEOqhVsUhWqGKBqIzD7RsXBYGSXSVibuR0sSlCqJy9ZegKNetKw54L9nR cFbwchqZuXv9CkR9V3vc5Wg1cu+2EXSkfi3/s898z51jAse6LXtM0cANdUGZoCovaGQC CEiCv2X5NhWjs6QZOsIzinKUwIcaN8lddeYqTG+TRTuJtWafGHEOrWhh5HkM7BxNf6sI 16aw== X-Gm-Message-State: ALoCoQmLbyKSm+r2UcKkhsMmt1MK3MMqyQUYGJdW0vZ5rEVE9otOMRjvz6UWnq9uUlNbUTbzcJa4 X-Received: by 10.180.91.76 with SMTP id cc12mr657558wib.7.1425058665971; Fri, 27 Feb 2015 09:37:45 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.7.42 with SMTP id g10ls202998laa.51.gmail; Fri, 27 Feb 2015 09:37:45 -0800 (PST) X-Received: by 10.152.27.232 with SMTP id w8mr8782505lag.51.1425058665742; Fri, 27 Feb 2015 09:37:45 -0800 (PST) Received: from mail-la0-f53.google.com (mail-la0-f53.google.com. [209.85.215.53]) by mx.google.com with ESMTPS id me18si3357270lbb.135.2015.02.27.09.37.45 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 27 Feb 2015 09:37:45 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.53 as permitted sender) client-ip=209.85.215.53; Received: by lams18 with SMTP id s18so19052916lam.13 for ; Fri, 27 Feb 2015 09:37:45 -0800 (PST) X-Received: by 10.152.115.136 with SMTP id jo8mr14211595lab.32.1425058665615; Fri, 27 Feb 2015 09:37:45 -0800 (PST) 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.35.133 with SMTP id h5csp4089609lbj; Fri, 27 Feb 2015 09:37:44 -0800 (PST) X-Received: by 10.140.44.69 with SMTP id f63mr29199341qga.3.1425058664021; Fri, 27 Feb 2015 09:37:44 -0800 (PST) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id d109si4686583qge.52.2015.02.27.09.37.42 (version=TLSv1 cipher=RC4-SHA bits=128/128); Fri, 27 Feb 2015 09:37:44 -0800 (PST) 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 1YROr6-0007ef-10; Fri, 27 Feb 2015 17:37:40 +0000 Received: from mail-lb0-f170.google.com ([209.85.217.170]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YROqW-0007cU-ES for lng-odp@lists.linaro.org; Fri, 27 Feb 2015 17:37:04 +0000 Received: by lbjf15 with SMTP id f15so18640955lbj.13 for ; Fri, 27 Feb 2015 09:36:58 -0800 (PST) X-Received: by 10.112.170.132 with SMTP id am4mr13644285lbc.89.1425058618024; Fri, 27 Feb 2015 09:36:58 -0800 (PST) Received: from localhost.localdomain (ppp91-76-170-205.pppoe.mtu-net.ru. [91.76.170.205]) by mx.google.com with ESMTPSA id wt7sm961216lbb.24.2015.02.27.09.36.56 (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Fri, 27 Feb 2015 09:36:56 -0800 (PST) From: Maxim Uvarov To: lng-odp@lists.linaro.org Date: Fri, 27 Feb 2015 20:36:29 +0300 Message-Id: <1425058589-7506-1-git-send-email-maxim.uvarov@linaro.org> X-Mailer: git-send-email 1.8.5.1.163.gd7aced9 X-Topics: patch Subject: [lng-odp] [PATCHv2] doc: clean up doxygen first page text 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: maxim.uvarov@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.53 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 Reviewed-by: Mike Holmes Signed-off-by: Maxim Uvarov --- doc/odp.dox | 33 ++++++--------------------------- 1 file changed, 6 insertions(+), 27 deletions(-) diff --git a/doc/odp.dox b/doc/odp.dox index b586421..f574e21 100644 --- a/doc/odp.dox +++ b/doc/odp.dox @@ -35,37 +35,16 @@ * of ODP, linux-generic is designed to provide best-in-class performance * for general Linux data plane support. * - * @section Staging + * @section ODP Releases * - * ODP is a work in progress and is expected to evolve significantly - * as it develops. Since the goal of ODP is to provide portability - * across disparate platforms and architectures while still providing - * near-native levels of performance on each conforming - * implementation, it is expected that the ODP architecture and the - * APIs presented here will evolve based on the experience in - * implementing and tuning ODP for operation on multiple platforms. - * For the time being, then, the goal here is not so much as to - * present a stable API, but rather a usable one that can be built - * upon to reach a clearly defined end goal. - * - * ODP releases will follow a standard major/minor/revision - * three-level naming designation. The intent is that APIs will be - * stable across major revisions such that existing APIs will work - * unchanged within a major revision, though minor revisions may add - * new APIs. Across major revisions some API changes may make - * application source changes necesary. These will be clearly noted - * in the release notes associated with any given ODP release. - * - * This consistency will commence with the 1.0.0 release of ODP, which - * is expected later in 2014. Pre-release 1 it should be expected - * that minor revisions may require API source changes as ODP is still - * "growing its roots". This is release 0.1.0 of ODP and is being - * made available as a "public preview" to the open source community - * for comment/feedback/evaluation. + * ODP releases follow a standard three-level naming designation. + * Changes to the API are reflected in the #ODP_VERSION_API_GENERATION + * and #ODP_VERSION_API_MAJOR numbers. A change to the #ODP_VERSION_API_MINOR + * number is used only for updates not breaking the API compatibility. * * @section contact Contact Details * - The main web site is http://www.opendataplane.org/ * - The git repo is https://git.linaro.org/lng/odp.git - * - Bug tracking is https://bugs.linaro.org/buglist.cgi?component=General&list_id=2474&product=OpenDataPlane + * - Bug tracking is https://bugs.linaro.org/buglist.cgi?product=OpenDataPlane * */