From patchwork Thu Oct 23 08:48:36 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ciprian Barbu X-Patchwork-Id: 39344 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f70.google.com (mail-wg0-f70.google.com [74.125.82.70]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 89BAF20341 for ; Thu, 23 Oct 2014 08:49:08 +0000 (UTC) Received: by mail-wg0-f70.google.com with SMTP id a1sf320855wgh.9 for ; Thu, 23 Oct 2014 01:49:07 -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:from:to:date:message-id:subject :precedence:list-id:list-unsubscribe:list-archive:list-post :list-help:list-subscribe:mime-version:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list :content-type:content-transfer-encoding; bh=2Y9prwJ2LwT1caUrfMW6oRtifBlA6I91zROOP+wak8Q=; b=N2yTafycV45zkpy5FoPha6Ra15gL0bhEo9X1s3f5f3fg/V0FP8U/AA9MWLnKmKX1k5 GHsADO49O8QOgJXZIIqWEeoJByO8suxpdxKM69GWLYpi4c9tr1rTpWjYvtELAeELRogI s81QTRM/bTPUTl4oINl1mcYLPT5o5EcOUe3UCrY+p21fHpGVjOKvLtxODtzVhthoHFOO iucoGjXID+4M3QhOW0yKG1ctFyGwooRw7rktlDivp155U09oPC/AZzaByIEQe2sru/6v oLLj1OKAaPz/zkBVY84ebD7HXAWLyGyuGDGEGO6Jo/DVghS5JhPHG/aZvOv2U2lJfj0c 1rqA== X-Gm-Message-State: ALoCoQnzOcWZvcwwPSH2WaFHiLIjCjptxMB+wj9f1H0C3vffaQlMlBzJ9QmnloEMDxBw+17Ta3hD X-Received: by 10.112.225.135 with SMTP id rk7mr760723lbc.6.1414054147662; Thu, 23 Oct 2014 01:49:07 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.234.233 with SMTP id uh9ls297355lac.70.gmail; Thu, 23 Oct 2014 01:49:07 -0700 (PDT) X-Received: by 10.152.206.36 with SMTP id ll4mr3580727lac.64.1414054147521; Thu, 23 Oct 2014 01:49:07 -0700 (PDT) Received: from mail-la0-f41.google.com (mail-la0-f41.google.com. [209.85.215.41]) by mx.google.com with ESMTPS id jw6si1537478lbc.101.2014.10.23.01.49.07 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 23 Oct 2014 01:49:07 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.41 as permitted sender) client-ip=209.85.215.41; Received: by mail-la0-f41.google.com with SMTP id pn19so687461lab.0 for ; Thu, 23 Oct 2014 01:49:07 -0700 (PDT) X-Received: by 10.152.120.199 with SMTP id le7mr3356551lab.67.1414054147083; Thu, 23 Oct 2014 01:49:07 -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.84.229 with SMTP id c5csp219415lbz; Thu, 23 Oct 2014 01:49:06 -0700 (PDT) X-Received: by 10.140.91.72 with SMTP id y66mr5065990qgd.52.1414054145605; Thu, 23 Oct 2014 01:49:05 -0700 (PDT) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id cz6si1852338qcb.41.2014.10.23.01.49.03 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 23 Oct 2014 01:49:05 -0700 (PDT) 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 1XhE4s-0008UT-Ld; Thu, 23 Oct 2014 08:49:02 +0000 Received: from mail-lb0-f172.google.com ([209.85.217.172]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XhE4m-0008UN-5U for lng-odp@lists.linaro.org; Thu, 23 Oct 2014 08:48:56 +0000 Received: by mail-lb0-f172.google.com with SMTP id b6so447354lbj.31 for ; Thu, 23 Oct 2014 01:48:49 -0700 (PDT) X-Received: by 10.112.132.104 with SMTP id ot8mr3466516lbb.3.1414054129889; Thu, 23 Oct 2014 01:48:49 -0700 (PDT) Received: from cipriantemp.enea.se (sestofw01.enea.se. [192.36.1.252]) by mx.google.com with ESMTPSA id nb7sm490018lbb.43.2014.10.23.01.48.48 for (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 23 Oct 2014 01:48:48 -0700 (PDT) From: Ciprian Barbu To: lng-odp@lists.linaro.org Date: Thu, 23 Oct 2014 11:48:36 +0300 Message-Id: <1414054116-6463-1-git-send-email-ciprian.barbu@linaro.org> X-Mailer: git-send-email 1.8.3.2 X-Topics: patch Subject: [lng-odp] [PATCHv3 NETMAP] linux-netmap: Include README in User's Guide 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: ciprian.barbu@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.41 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: Ciprian Barbu --- Resending v3 with correct version to version change description v3: Added linux-generic back to User's Guide v2: Removed all but linux-netmap from User's Guide; Renamed PROJECT_NAME to "ODP Netmap API Reference Manual" v1: Added linux-netmap instructions to User's Guide alongside the descriptions for the other platforms doc/doxygen.cfg | 2 +- doc/users-guide/guide.dox | 6 ++---- platform/linux-netmap/README | 14 +++++++++++++- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg index a77ae1e..fc56317 100644 --- a/doc/doxygen.cfg +++ b/doc/doxygen.cfg @@ -1,4 +1,4 @@ -PROJECT_NAME = "API Reference Manual" +PROJECT_NAME = "ODP Netmap API Reference Manual" PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.png QUIET = YES OUTPUT_DIRECTORY = $(DOCDIR) diff --git a/doc/users-guide/guide.dox b/doc/users-guide/guide.dox index 314d295..11ec395 100644 --- a/doc/users-guide/guide.dox +++ b/doc/users-guide/guide.dox @@ -10,9 +10,7 @@ * * @section sec_gene Linux Generic * @verbinclude linux-generic/README - * @section sec_dpdk Linux DPDK - * @verbinclude linux-dpdk/README - * @section sec_keys Linux Keystone2 - * @verbinclude linux-keystone2/README + * @section sec_netm Linux Netmap + * @verbinclude linux-netmap/README * */ diff --git a/platform/linux-netmap/README b/platform/linux-netmap/README index 6021445..795a6fc 100644 --- a/platform/linux-netmap/README +++ b/platform/linux-netmap/README @@ -66,8 +66,20 @@ Now compile netmap: 2.2 Building ODP ---------------- +This default platform for this repository is linux-netmap, if not otherwise +specified using the --with-platform configure variable. +The optional --with-sdk-install-path variable is used to point to the netmap +sources, if it's not specified the build system will try to find netmap header +files in the standard include directories. + ./bootstrap - ./configure --with-platform=linux-netmap --with-sdk-install-path= + +To configure ODP for linux-netmap: + ./configure --with-sdk-install-path= + +To configure ODP for linux-generic: + ./configure --with-platform=linux-generic + make 3. Running the example application