From patchwork Wed Dec 17 18:10:32 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 42394 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 55E7C26C8B for ; Wed, 17 Dec 2014 18:12:16 +0000 (UTC) Received: by mail-la0-f71.google.com with SMTP id q1sf10414190lam.2 for ; Wed, 17 Dec 2014 10:12:14 -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=oNBT5NE4BBOrUdWy54iA+9di1G8KDbc/J70BYweAWQE=; b=LV6CWStL6eatn4nfgz5BW2LDhLUERbqNVX5xmjEl6X9EL3e5IW8FiT2AoT1lCb1rE6 thLSdu75pxAj1NOQP7j52P9oK7Gsagp9bzBJsIzvwT3nTI60sj9WtITzSyOiIfqW0SuT hnwyPp6qTfmJXd7oZ8bIc5y0mK0LRwN3EndAEKN4FMBViiVPaDbPWbeO/iPBr478O09D B84lLL8XzXsKUXLwhPoNpCwb4VTfL6xBHcnOPoKmpSOgx8v/EoakMLGk9oFx1adAVyjf kwZCA9+H8ra5WuL0icyo6su4L5j/pw7nREhIcMSmCiwBmjAukwmO4EhwQoupLC7cyxd3 2GtQ== X-Gm-Message-State: ALoCoQnYmBo9pBqJgQg+tjCIPSQ4hjG/vAohE8reghmoXYefFPrTStvr0tKnwLuyNiHZ0ppiuG7p X-Received: by 10.112.140.137 with SMTP id rg9mr10136lbb.24.1418839934955; Wed, 17 Dec 2014 10:12:14 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.7.7 with SMTP id f7ls571902laa.8.gmail; Wed, 17 Dec 2014 10:12:14 -0800 (PST) X-Received: by 10.112.185.99 with SMTP id fb3mr15883477lbc.21.1418839934809; Wed, 17 Dec 2014 10:12:14 -0800 (PST) Received: from mail-lb0-f177.google.com (mail-lb0-f177.google.com. [209.85.217.177]) by mx.google.com with ESMTPS id w4si3227726law.77.2014.12.17.10.12.14 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 17 Dec 2014 10:12:14 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.177 as permitted sender) client-ip=209.85.217.177; Received: by mail-lb0-f177.google.com with SMTP id b6so12850110lbj.22 for ; Wed, 17 Dec 2014 10:12:14 -0800 (PST) X-Received: by 10.152.23.38 with SMTP id j6mr34943519laf.81.1418839933992; Wed, 17 Dec 2014 10:12:13 -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.142.69 with SMTP id ru5csp1446946lbb; Wed, 17 Dec 2014 10:12:13 -0800 (PST) X-Received: by 10.229.61.5 with SMTP id r5mr18775773qch.28.1418839932693; Wed, 17 Dec 2014 10:12:12 -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 w67si5456772qge.33.2014.12.17.10.12.09 (version=TLSv1 cipher=RC4-SHA bits=128/128); Wed, 17 Dec 2014 10:12:12 -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 1Y1J4w-00049D-Fm; Wed, 17 Dec 2014 18:12:06 +0000 Received: from mail-qg0-f47.google.com ([209.85.192.47]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Y1J4q-00047I-DA for lng-odp@lists.linaro.org; Wed, 17 Dec 2014 18:12:00 +0000 Received: by mail-qg0-f47.google.com with SMTP id q108so9989209qgd.20 for ; Wed, 17 Dec 2014 10:11:55 -0800 (PST) X-Received: by 10.229.196.70 with SMTP id ef6mr78029837qcb.31.1418839908237; Wed, 17 Dec 2014 10:11:48 -0800 (PST) Received: from localhost.localdomain ([98.221.136.245]) by mx.google.com with ESMTPSA id d109sm4535274qge.9.2014.12.17.10.11.47 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 17 Dec 2014 10:11:47 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Wed, 17 Dec 2014 13:10:32 -0500 Message-Id: <1418839832-12286-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [PATCH] DEPENDENCIES: add documentation instructions 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: 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.177 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 In order to build the documentation doxygen is required, to generate a pdf further tools are needed. Add instructions on how to do this. Signed-off-by: Mike Holmes Reviewed-by: Anders Roxell --- DEPENDENCIES | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/DEPENDENCIES b/DEPENDENCIES index f70a1d4..62e703d 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -98,3 +98,17 @@ Prerequisites for building the OpenDataPlane (ODP) API $ Add the configuration option to the regular configuration options ./configure --enable-cunit #if cunit is in the PATH ./configure --with-cunit-path=DIR #only if you need a path to Cunit libs and headers + +5.0 Documentation & Doxygen + +See http://www.stack.nl/~dimitri/doxygen/manual/install.html + +The tested version of doxygen is 1.8.8 + +5.1 HTML + # Debian/Ubuntu + $ apt-get install doxygen graphviz + +5.2 PDF + # Debian/Ubuntu + $ apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended