From patchwork Thu Aug 11 16:44:30 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxim Uvarov X-Patchwork-Id: 73803 Delivered-To: patch@linaro.org Received: by 10.140.29.52 with SMTP id a49csp201606qga; Thu, 11 Aug 2016 09:44:44 -0700 (PDT) X-Received: by 10.55.72.79 with SMTP id v76mr11546774qka.194.1470933884397; Thu, 11 Aug 2016 09:44:44 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id s31si2057552qtb.18.2016.08.11.09.44.43; Thu, 11 Aug 2016 09:44:44 -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; 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; dmarc=pass (p=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id C2A4561E08; Thu, 11 Aug 2016 16:44:43 +0000 (UTC) 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.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL 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 ED4D561DFB; Thu, 11 Aug 2016 16:44:39 +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 B583561606; Thu, 11 Aug 2016 16:44:38 +0000 (UTC) Received: from mail-wm0-f46.google.com (mail-wm0-f46.google.com [74.125.82.46]) by lists.linaro.org (Postfix) with ESMTPS id 4AB8061DFB for ; Thu, 11 Aug 2016 16:44:37 +0000 (UTC) Received: by mail-wm0-f46.google.com with SMTP id d196so389201wmd.0 for ; Thu, 11 Aug 2016 09:44:37 -0700 (PDT) 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; bh=41JkQ+IKhM7OOnwW+OsVmF7W4Z18hkSV2cB7MhqIM2o=; b=GvCx6ns0FoKXNgrLB+t14chGXn7nazQ/5UyaWCtLQdv3cWe7Mf9H9Be21lw9ozRRSb emLQoZk6408Ssqhp+JTcK+bF/UILs20WYs8LAeB3qNfpL6ibYWHHovSgFQ9FzHQXaeHA bqws0UUTPm8q5FCKFoJ9CHsdESvNCiPVCdAeWGSEG6hEnoX+enXVz+OvgkrjkLjEPL7m q9+hHQ2uV4prICpxM+WVDJpOnAPUedPQfBscUA3QO1KJTuD81sO2puA2nfy3m8k3pZkC KeZp5wI58jt/ixOuM8X3jadkW2UmZzsRN5VorBR+uVBH+7C2lfg53jvV7OSpbJuWSK9V Qaqg== X-Gm-Message-State: AEkoout5f4PC1JzZhhybFxKsTr4ri+Ye9pZH1NWmvso9SN9+dMfUlYLB0VX83TDYAodwFY5hFvA= X-Received: by 10.25.168.212 with SMTP id r203mr2009907lfe.85.1470933876302; Thu, 11 Aug 2016 09:44:36 -0700 (PDT) Received: from localhost.localdomain ([83.220.237.18]) by smtp.gmail.com with ESMTPSA id o10sm226141lfo.47.2016.08.11.09.44.34 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 11 Aug 2016 09:44:35 -0700 (PDT) From: Maxim Uvarov To: lng-odp@lists.linaro.org Date: Thu, 11 Aug 2016 19:44:30 +0300 Message-Id: <1470933870-25845-1-git-send-email-maxim.uvarov@linaro.org> X-Mailer: git-send-email 2.7.1.250.gff4ea60 X-Topics: patch Subject: [lng-odp] [PATCHv2] example: odp_l2fwd place readme with symlink 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: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" odp_l2fwd is standalone application which can be used as example or as performance test. Hiding it inside performance tests might be not new users friendly way. Create symlink with small readme file for better finding it. Signed-off-by: Maxim Uvarov --- v2: add to examples.dox (alphabetical) doc/application-api-guide/examples.dox | 15 ++++++++++----- example/l2fwd/README | 8 ++++++++ example/l2fwd/odp_l2fwd.c | 1 + 3 files changed, 19 insertions(+), 5 deletions(-) create mode 100644 example/l2fwd/README create mode 120000 example/l2fwd/odp_l2fwd.c -- 2.7.1.250.gff4ea60 diff --git a/doc/application-api-guide/examples.dox b/doc/application-api-guide/examples.dox index 2dccd7f..60d4058 100644 --- a/doc/application-api-guide/examples.dox +++ b/doc/application-api-guide/examples.dox @@ -5,11 +5,21 @@ */ /** + * @example odp_classifier.c + * ODP classifier example application + */ + +/** * @example odp_generator.c * ODP loopback demo application */ /** + * @example odp_l2fwd.c + * ODP l2fwd example application + */ + +/** *@example odp_pktio.c * ODP basic packet IO loopback test application */ @@ -18,8 +28,3 @@ * @example odp_timer_test.c * ODP timer example application */ - -/** - * @example odp_classifier.c - * ODP classifier example application - */ diff --git a/example/l2fwd/README b/example/l2fwd/README new file mode 100644 index 0000000..891620b --- /dev/null +++ b/example/l2fwd/README @@ -0,0 +1,8 @@ + ODP L2FWD application + +Source code and Makefiles placed under test/common_plat/performance/ +directory. + +This L2 forwarding application can be used as example reference as well +as performance test for different odp modes (direct, queue or scheduler +with parallel, atomic or ordered queues). diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c new file mode 120000 index 0000000..eea3a34 --- /dev/null +++ b/example/l2fwd/odp_l2fwd.c @@ -0,0 +1 @@ +../../test/common_plat/performance/odp_l2fwd.c \ No newline at end of file