diff mbox

Add /scripts/install_build_deps.sh

Message ID CADz3at30Ea0fe=hoROrANe6KAra0TDJVv9zVT2GyWgxhcpudsQ@mail.gmail.com
State New
Headers show

Commit Message

Mike Holmes Nov. 7, 2016, 6:38 p.m. UTC 
On 25 October 2016 at 03:11, Brian Brooks <brian.brooks@linaro.org> wrote:

> On 10/31 18:53:27, Brian Brooks wrote:

> > and update build-related documentation.

> >

> > Signed-off-by: Brian Brooks <brian.brooks@linaro.org>

> > ---

> >  DEPENDENCIES                  | 262 ------------------------------

> ------------

> >  README                        | 216 ++++++++++++++++++++++++++++++----

> >  platform/linux-generic/README |  17 ---

> >  scripts/install_build_deps.sh | 124 ++++++++++++++++++++

> >  4 files changed, 315 insertions(+), 304 deletions(-)

> >  delete mode 100644 DEPENDENCIES

> >  delete mode 100644 platform/linux-generic/README

> >  create mode 100755 scripts/install_build_deps.sh

> >

> > diff --git a/DEPENDENCIES b/DEPENDENCIES

> > deleted file mode 100644

> > index f1f0edd..0000000

> > --- a/DEPENDENCIES

> > +++ /dev/null

> > @@ -1,262 +0,0 @@

> > -Prerequisites for building the OpenDataPlane (ODP) API

> > -

> > -1. Linux kernel >= 2.6.32

> > -

> > -   Earlier versions may or may not work.

> > -

> > -2. autotools

> > -

> > -   automake

> > -   autoconf

> > -   libtool

> > -

> > -   On Debian/Ubuntu systems:

> > -   $ sudo apt-get install automake autoconf libtool

> > -

> > -   On CentOS/RedHat/Fedora systems:

> > -   $ sudo yum install automake autoconf libtool

> > -

> > -3. Required libraries

> > -

> > -   Libraries currently required to link: openssl

> > -

> > -3.1 OpenSSL native compile

> > -

> > -   For native compilation, simply load the necessary libraries using

> the appropriate

> > -   tool set.

> > -

> > -   On Debian/Ubuntu systems:

> > -   $ sudo apt-get install libssl-dev

> > -

> > -   On CentOS/RedHat/Fedora systems:

> > -   $ sudo yum install openssl-devel

> > -

> > -3.2 OpenSSL cross compilation

> > -

> > -   Cross compilation requires cross compiling the individual

> libraries.  In order for

> > -   a cross compiled executable to run on a target system, one must

> build the same

> > -   version as that which is installed on the target rootfs.

> > -

> > -   For example, to build openssl for both 32 and 64 bit compilation:

> > -

> > -   # Clone openssl repository

> > -   $ git clone git://git.openssl.org/openssl.git

> > -   $ cd openssl

> > -

> > -   # The command "git tag" will list all tags available in the repo.

> > -   $ git tag

> > -

> > -   # Checkout the specific tag to match openssl library in your target

> rootfs

> > -   $ git checkout <tag name>

> > -

> > -   # Build and install 32 bit version of openssl

> > -   $ ./Configure linux-generic32 --cross-compile-prefix=arm-linux-gnueabihf-

> \

> > -     --prefix=/home/user/src/install-openssl shared

> > -   $ make

> > -   $ make install

> > -

> > -   # Build and install 64 bit version of openssl

> > -   $ ./Configure linux-generic64 --cross-compile-prefix=aarch64-linux-gnu-

> \

> > -     --prefix=/home/user/src/install-openssl-aarch64 shared

> > -   $ make

> > -   $ make install

> > -

> > -   # You may now build either 32 or 64 bit ODP

> > -   $ git clone git://git.linaro.org/lng/odp.git odp

> > -   $ cd odp

> > -   $ ./bootstrap

> > -

> > -   # Build 32 bit version of ODP

> > -   $ ./configure --host=arm-linux-gnueabihf \

> > -     --with-openssl-path=/home/user/src/install-openssl

> > -   $ make

> > -

> > -   # Or build 64 bit version of ODP

> > -   $ ./configure --host=aarch64-linux-gnu \

> > -     --with-openssl-path=/home/user/src/install-openssl-aarch64

> > -   $ make

> > -

> > -3.3 Netmap packet I/O support (optional)

> > -

> > -   Netmap accelerated ODP packet I/O.

> > -

> > -3.3.1 Building netmap kernel modules

> > -

> > -   ODP works at least with the latest release version of netmap, which

> is

> > -   currently 11.1. However, if possible one should try to use the

> latest netmap

> > -   master branch commit for the best performance and the latest bug

> fixes.

> > -

> > -   # Checkout netmap code

> > -   $ git clone https://github.com/luigirizzo/netmap.git

> > -   $ cd netmap

> > -   $ git checkout v11.1 (optional)

> > -

> > -   This is enough to build ODP. If you don't want to build netmap kernel

> > -   modules you can jump to section 3.3.2.

> > -

> > -   Netmap consists of a core kernel module (netmap.ko), optional

> modified

> > -   device drivers and user space API headers to access the netmap

> > -   functionality. It is recommended to build both the core module and

> modified

> > -   device drivers for optimal performance.

> > -

> > -   Netmap builds as an out-of-tree kernel module, you need matching

> kernel

> > -   sources to compile it. General build instructions can be found in

> the packet

> > -   README: https://github.com/luigirizzo/netmap/blob/master/LINUX/

> README.

> > -

> > -   If you are running Ubuntu/Debian with the stock kernel and you want

> to

> > -   compile both netmap.ko and modified drivers, these steps will guide

> you

> > -   through it.

> > -

> > -   # Download kernel headers

> > -   $ sudo apt-get install linux-headers-$(uname -r)

> > -

> > -   # Download kernel source matching to the headers

> > -   $ sudo apt-get install linux-source

> > -   # or

> > -   $ apt-get source linux-image-$(uname -r)

>

> Note that netmap instructions for kernel source have been updated to work

> for

> any distro.

>

> > -   The source archive will be placed in /usr/src/linux-source-<kernel-

> version>

> > -   (or in the current directory if using apt-get source). You will need

> to

> > -   locate it and extract it to a convenient place.

> > -

> > -   # Compile netmap

> > -   $ cd <netmap_dir>/LINUX

> > -   $ ./configure --kernel-sources=<path_to_kernel_src>

> > -   $ make

> > -

> > -3.3.2 Building ODP

> > -

> > -   $ cd <odp_dir>

> > -   $ ./bootstrap

> > -   $ ./configure --with-netmap-path=<netmap_dir>

> > -   $ make

> > -

> > -3.3.3 Inserting netmap kernel modules

> > -

> > -   In order to use netmap I/O you need to insert at least the core

> netmap

> > -   kernel module.

> > -

> > -   $ cd <netmap_dir>/LINUX

> > -   $ sudo insmod netmap.ko

> > -

> > -   To insert the optional modified drivers you first need to remove the

> > -   original drivers, if loaded (and if not linked into the kernel). For

> > -   example, if using ixgbe:install_build_deps.sh

> > -

> > -   $ cd <netmap_path>/LINUX

> > -   $ sudo rmmod ixgbe

> > -   $ sudo insmod ixgbe/ixgbe.ko

> > -

> > -   To restore the original drivers you should be able to use modprobe.

> > -

> > -3.3.4 Running ODP with netmap I/O

> > -

> > -   ODP applications will use netmap for packet I/O by default as long

> as the

> > -   netmap kernel module is loaded. If socket I/O is desired instead, it

> can be

> > -   activated by setting the environment variable

> ODP_PKTIO_DISABLE_NETMAP.

> > -

> > -3.4 DPDK packet I/O support (optional)

> > -

> > -   Use DPDK for ODP packet I/O.

> > -

> > -   Note: only packet I/O is accelerated with DPDK. Use

> > -     https://git.linaro.org/lng/odp-dpdk.git

> > -   for fully accelerated odp dpdk platform.

> > -

> > -3.4.1 Building DPDK and ODP with DPDK pktio support

> > -

> > -   DPDK packet I/O has been tested to work with DPDK v16.07.

> > -

> > -   Follow steps in ./scripts/build-pktio-dpdk

> > -

> > -3.4.2 Setup system

> > -

> > -   # Load DPDK modules

> > -   $ sudo /sbin/modprobe uio

> > -   $ cd <dpdk-dir>

> > -   $ sudo insmod x86_64-native-linuxapp-gcc/kmod/igb_uio.ko

> > -

> > -   Reserve and mount hugepages and bind supported interfaces to DPDK

> modules

> > -   following the DPDK documentation. ODP DPDK packet I/O has been

> tested with

> > -   512 x 2MB hugepages. All this can be done with the DPDK setup script

> > -   (<dpdk-dir>/tools/dpdk-setup.sh).

> > -

> > -3.4.3 Running ODP with DPDK pktio

> > -

> > -   ODP applications will try use DPDK for packet I/O by default. If

> some other

> > -   I/O type is desired instead, DPDK I/O can be disabled by setting the

> > -   environment variable ODP_PKTIO_DISABLE_DPDK.

> > -

> > -   DPDK interfaces are accessed using indices. For example, two first

> DPDK

> > -   interfaces can be used with the odp_l2fwd example as follows:

> > -   $ cd <odp_dir>

> > -   $ sudo ./test/performance/odp_l2fwd -i 0,1 -c 2 -m 0

> > -

> > -   Additionally, DPDK command line options can be passed to the

> application

> > -   using ODP_PKTIO_DPDK_PARAMS environment variable. For example,

> allocate

> > -   1024MB of memory:

> > -   $ sudo ODP_PKTIO_DPDK_PARAMS="-m 1024" ./test/performance/odp_l2fwd

> -i 0 -c 1

> > -

> > -4.0 Packages needed to build API tests

> > -

> > -   Cunit test framework version 2.1-3 is required

> > -   Cunit prvodes a framework to run the API test suite that proves

> conformance to the

> > -   ODP API. The home page http://cunit.sourceforge.net/

> doc/introduction.html

> > -

> > -4.1 Native Cunit install

> > -

> > -   # Debian/Ubuntu

> > -   $ apt-get install libcunit1-dev

> > -

> > -4.2 Built from src

> > -

> > -   export CUNIT_VERSION=2.1-3

> > -   curl -sSOL http://sourceforge.net/projects/cunit/files/CUnit/${

> CUNIT_VERSION}/CUnit-${CUNIT_VERSION}.tar.bz2

> > -   tar -jxf *.bz2

> > -   cd CUnit*

> > -   ./bootstrap

> > -   make install

> > -   #In Step 4.4 use --with-cunit-path=/home/${USER}/CUnitHome

> > -

> > -4.3 Cross compile of Cunit

> > -

> > -   $ git svn clone http://svn.code.sf.net/p/cunit/code/trunk cunit-code

> > -   $ cd cunit-code

> > -   $ ./bootstrap

> > -   $ ./configure --host=arm-linux-gnueabihf --prefix=/home/${USER}/src/

> install-cunit

> > -

> > -4.4 Using Cunit with ODP

> > -   $ 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 Images & Doxygen

> > -

> > -  Images are stored as svg files. No conversions for these are needed.

> > -

> > -  Message squence diagrams are stored as msc files and the svg versions

> generated when the docs are built

> > -  mscgen is used

> > -  #Debian/Ubuntu

> > -  # apt-get install mscgen

> > -

> > -5.1 API Guide

> > -See http://www.stack.nl/~dimitri/doxygen/manual/install.html

> > -

> > -The tested version of doxygen is 1.8.8

> > -

> > -5.1.1 HTML

> > -   # Debian/Ubuntu

> > -   $ apt-get install doxygen graphviz

> > -

> > -5.2 User guides

> > -

> > -5.2.1 HTML

> > -   # Debian/Ubuntu

> > -   $ apt-get install asciidoctor source-highlight librsvg2-bin

> > -

> > -6.0 Submitting patches

> > -

> > -   When submitting patches they should be checked with ./scripts/

> checkpatch.pl

> > -   To have this tool also check spelling you need codespell.

> > -   # Debian/Ubuntu

> > -   #sudo apt install codespell

> > diff --git a/README b/README

> > index 4350b95..b7771c8 100644

> > --- a/README

> > +++ b/README

> > @@ -9,31 +9,6 @@ OpenDataPlane (ODP) project source code.

> >  Main git repository:

> >      git://git.linaro.org/lng/odp.git

> >

> > -    How to build:

> > -    Look in platform/linux-*/README for more detail how to build.

> > -    Directory test contains test applications for ODP API calls and

> features support.

> > -

> > -    For a list of build dependencies, read

> DEPENDENCIES.install_build_deps.shinstall_build_deps.sh

> > -    In general you can build:

> > -    ./bootstrap

> > -    ./configure

> > -    Use 'make' to build ODP library and samples and 'make doxygen-doc'

> to build

> > -    ODP API documentation. 'make install' will copy all required

> headers and

> > -    binary files to the install directory.

> > -

> > -    Configure options:

> > -        ./configure --help

> > -

> > -    To execute all the testcases, assuming CUnit is installed for the

> validation tests:

> > -        ./bootstrap

> > -        ./configure --enable-test-perf --enable-test-vald

> > -        make check

> > -

> > -    To generate the users guides:

> > -        ./bootstrap

> > -        ./configure --enable-user-guide

> > -        make

> > -

> >  Patches tracking system:

> >      http://patches.opendataplane.org/project/lng-odp/list/

> >

> > @@ -41,8 +16,199 @@ Mailing list:

> >      lng-odp@lists.linaro.org

> >

> >      Please read CONTRIBUTING file before submitting patches.

> > +    When submitting patches they should be checked with ./scripts/

> checkpatch.pl

> > +    To have this tool also check spelling you need codespell.

> >      Email prefixes:

> >          [PATCH] means patch is for odp.git

> >

> >  Bug tracking:

> >      https://bugs.linaro.org/describecomponents.cgi?

> product=OpenDataPlane%20-%20linux-%20generic%20reference

> > +

> > +Build Guide:

> > +

> > +  Quickstart:

> > +

> > +    $ ./scripts/install_build_deps.sh

> > +    $ ./bootstrap

> > +    $ ./configure \

> > +        --enable-user-guides \

> > +        --enable-debug \

> > +        --enable-debug-print \

> > +        --enable-cunit-support \

> > +        --enable-test-example \

> > +        --enable-test-helper \

> > +        --enable-test-cpp \

> > +        --enable-test-perf \

> > +        --enable-test-perf-proc \

> > +        --enable-test-vald \

> > +        --enable-abi-compat \

> > +        --enable-netmap-support \

> > +        --enable-dpdk-support

> > +    $ make -j`nproc`

> > +    $ make check

> > +    $ make doxygen-doc

> > +    $ make install

> > +

> > +  Dependencies:

> > +

> > +    See /scripts/install_build_deps.sh

> > +

> > +    Runtime

> > +

> > +      * Linux kernel >= 2.6.32

> > +      * OpenSSL

> > +      * PCAP (optional)

> > +      * Netmap (optional)

> > +      * DPDK (optional)

> > +

> > +    Development

> > +

> > +      * Autotools

> > +      * Doxygen, Graphviz, Asciidoctor, mscgen

> > +      * CUnit == 2.1.3

> > +      * Valgrind, gcov

> > +

> > +  Configuration:

> > +

> > +    $ ./bootstrap

> > +

> > +    $ ./configure --help

> > +

> > +    --host=                             # Cross compiling

> > +

> > +        Toolchain prefix: aarch64-linux-gnu

> > +                          arm-linux-gnueabihf

> > +                          mips64-linux-gnu

> > +

> > +    --enable-user-guides                # Docs

> > +

> > +            Build /doc/users-guide

> > +                  /doc/implementers-guide

> > +                  /doc/process-guide

> > +

> > +    --enable-debug

> > +    --enable-debug-print

> > +

> > +    --enable-cunit                      # Testing

> > +    --enable-cunit-support

> > +    --with-cunit-path=DIR

> > +    --enable-test-example

> > +    --enable-test-helper

> > +    --enable-test-cpp

> > +    --enable-test-perf

> > +    --enable-test-perf-proc

> > +    --enable-test-vald

> > +

> > +    --enable-valgrind

> > +

> > +    --enable-abi-compat

> > +

> > +    --with-platform=platform

> > +

> > +            Select code in /platform/<platform>/

> > +

> > +    --with-openssl-path=DIR

> > +

> > +    --enable-netmap-support, --with-netmap-path=DIR

> > +

> > +    --enable-dpdk-support, --with-dpdk-path=DIR

> > +

> > +    --enable-pktio_ipc-support

> > +

> > +    --enable-schedule-sp

> > +

> > +    --with-sdk-install-path=DIR

> > +

> > +  Targets:

> > +

> > +    make

> > +    make check

> > +    make doxygen-doc

> > +    make install

> > +

> > +  Dependencies (from source):

> > +

> > +    CUnit

> > +

> > +      --with-cunit-path=/home/${USER}/CUnitHome

> > +

> > +      $ export CUNIT_VERSION=2.1-3

> > +      $ curl -sSOL http://sourceforge.net/projects/cunit/files/CUnit/${

> CUNIT_VERSION}/CUnit-${CUNIT_VERSION}.tar.bz2

> > +      $ tar -jxf *.bz2

> > +      $ cd CUnit*

> > +      $ ./bootstrap ; make install

> > +

> > +      Cross compilation

> > +

> > +      $ git svn clone http://svn.code.sf.net/p/cunit/code/trunk

> cunit-code

> > +      $ cd cunit-code

> > +      $ ./bootstrap

> > +      $ ./configure --host=arm-linux-gnueabihf

> --prefix=/home/${USER}/src/install-cunit

> > +

> > +    OpenSSL

> > +

> > +      --with-openssl-path=/home/user/src/install-openssl

> > +

> > +      TODO: host/native build

> > +

> > +      Cross Compilation

> > +

> > +      $ git clone git://git.openssl.org/openssl.git

> > +      $ cd openssl

> > +      $ git tag

> > +      $ git checkout <tag name>

> > +      $ ./configure linux-generic64 --cross-compile-prefix=aarch64-linux-gnu-

> \

> > +             --prefix=/home/user/src/install-openssl-aarch64 shared

> > +      $ make

> > +      $ make install

> > +

> > +    Netmap

> > +

> > +      --with-netmap-path=<path>

> > +

> > +      $ KERNEL_VERS=`uname -r | cut -d- -f1 -`

> > +      $ wget https://cdn.kernel.org/pub/linux/kernel/v4.x/linux-$

> KERNEL_VERS.tar.xz

> > +      $ xz --decompress linux-$KERNEL_VERS.tar.xz

> > +      $ tar -xf linux-$KERNEL_VERS.tar.xz

> > +

> > +      $ git clone https://github.com/luigirizzo/netmap.git

> > +      $ cd netmap

> > +      $ git checkout v11.1

> > +      $ cd LINUX

> > +      $ ./configure --kernel-sources=$HOME/linux-$KERNEL_VERS

> > +      $ make

> > +

> > +      $ sudo insmod netmap.ko

> > +      $ sudo rmmod ixgbe

> > +      $ sudo insmod ixgbe/ixgbe.ko

> > +

> > +      ODP_PKTIO_DISABLE_NETMAP environment variable: use sockets

> instead of netmap

> > +

> > +    DPDK

> > +

> > +      See /scripts/build-pktio-dpdk

> > +

> > +      ODP applications will try use DPDK for packet I/O by default. If

> some other

> > +      I/O type is desired instead, DPDK I/O can be disabled by setting

> the

> > +      environment variable ODP_PKTIO_DISABLE_DPDK.

> > +

> > +      DPDK interfaces are accessed using indices. For example, two

> first DPDK

> > +      interfaces can be used with the odp_l2fwd example as follows:

> > +      $ cd <odp_dir>

> > +      $ sudo ./test/performance/odp_l2fwd -i 0,1 -c 2 -m 0

> > +

> > +      Additionally, DPDK command line options can be passed to the

> application

> > +      using ODP_PKTIO_DPDK_PARAMS environment variable. For example,

> allocate

> > +      1024MB of memory:

> > +      $ sudo ODP_PKTIO_DPDK_PARAMS="-m 1024"

> ./test/performance/odp_l2fwd -i 0 -c 1

> > +

> > +      Reserve and mount hugepages and bind supported interfaces to DPDK

> modules

> > +      following the DPDK documentation. ODP DPDK packet I/O has been

> tested with

> > +      512 x 2MB hugepages. All this can be done with the DPDK setup

> script

> > +      (<dpdk-dir>/tools/dpdk-setup.sh).

> > +

> > +      $ sudo /sbin/modprobe uio

> > +      $ cd <dpdk-dir>

> > +      $ sudo insmod x86_64-native-linuxapp-gcc/kmod/igb_uio.ko

> > +

> > +      See https://git.linaro.org/lng/odp-dpdk.git for better DPDK

> integration

> > \ No newline at end of file

> > diff --git a/platform/linux-generic/README b/platform/linux-generic/

> README

> > deleted file mode 100644

> > index 3e05dab..0000000

> > --- a/platform/linux-generic/README

> > +++ /dev/null

> > @@ -1,17 +0,0 @@

> > -Copyright (c) 2014, Linaro Limited

> > -All rights reserved.

> > -

> > -SPDX-License-Identifier:        BSD-3-Clause

> > -

> > -1. Intro

> > -

> > -OpenDataPlane implementation for Linux generic. Directory linux-generic

> contains ODP headers and implementation

> > -for linux-generic target. This drop does not target high

> > -performance. It is rather proof of ODP API functionality. It still uses

> > -linux-generic's SW scheduler.

> > -

> > -2. Build

> > -# To compile ODP

> > -./bootstrap

> > -./configure

> > -make

> > diff --git a/scripts/install_build_deps.sh b/scripts/install_build_deps.

> sh

> > new file mode 100755

> > index 0000000..074661f

> > --- /dev/null

> > +++ b/scripts/install_build_deps.sh

> > @@ -0,0 +1,124 @@

> > +#!/bin/bash

> > +

> > +# Copyright (c) 2016, Linaro Limited

> > +# All rights reserved.

> > +#

> > +# SPDX-License-Identifier:        BSD-3-Clause

> > +

> > +if [ -f /etc/lsb-release ]; then

> > +    source /etc/lsb-release

> > +elif [ -f /etc/debian_version ]; then

> > +    DISTRIB_ID=Debian

> > +elif [ -f /etc/centos-release ]; then

> > +    DISTRIB_ID=CentOS

> > +else

> > +    echo "Unknown OS" 1>&2

> > +    exit 1

> > +fi

> > +

> > +pkgmgr_install() {

> > +    local pkgs="$1"

> > +

> > +    case $DISTRIB_ID in

> > +        Arch) yaourt -S --needed $pkgs ;;

> > +        Ubuntu) ;&

> > +        Debian) apt-get install $pkgs ;;

> > +        Fedora) ;&

> > +        CentOS) ;&

> > +        RedHat) yum install $pkgs ;;

> > +    esac

> > +}

> > +

> > +post_install() {

> > +    case $DISTRIB_ID in

> > +        RedHat) ;&

> > +        CentOS) gem install asciidoctor ;;

> > +    esac

> > +}

> > +

> > +main() {

> > +    local pkgs=""

> > +

> > +    pkgs+="autoconf automake libtool "

> > +    pkgs+="make "

> > +

> > +    case $DISTRIB_ID in

> > +        Arch) pkgs+="pkg-config " ;;

> > +        Ubuntu) ;&

> > +        Debian) pkgs+="pkg-config " ;;

> > +        Fedora) ;&

> > +        CentOS) ;&

> > +        RedHat) pkgs+="pkgconfig " ;;

> > +

> > +    esac

> > +

> > +    pkgs+="doxygen "

> > +    pkgs+="graphviz "

> > +    case $DISTRIB_ID in

> > +        Arch) ;&

> > +        Ubuntu) ;&

> > +        Debian) ;&

> > +        Fedora) pkgs+="asciidoctor " ;;

> > +        RedHat) ;&

> > +        CentOS) pkgs+="gem " ;;

> > +    esac

> > +    case $DISTRIB_ID in

> > +        # FIXME: RPMs are no longer hosted here. Cannot install mscgen

> > +        # on these distros.

> > +        Fedora)

> > +            wget -O /etc/yum.repos.d/mscgen.repo \

> > +                http://www.mcternan.me.uk/mscgen/yum/fedora/mscgen.repo

> ;;

> > +        RedHat) ;&

> > +        CentOS)

> > +            wget -O /etc/yum.repos.d/mscgen.repo \

> > +                http://www.mcternan.me.uk/mscgen/yum/epel/mscgen.repo

> ;;

> > +    esac

> > +    pkgs+="mscgen "

>

> Note that I was unable to develop ODP on Fedora or CentOS due to mscgen and

> asciidoctor not being fully available.

>

> These deps are only required for building documentation, but sadly even if

> --enable-user-guide is not passed (to avoid building documentation)

> configure.ac will still check for these deps and bail if not found.

>


Can you update the configure.m4 to not consider it an error if the user
guide support it not there ?
There will still be a warning, I see the following on a vanilla fedora
docker image

configure: WARNING: Doxygen not found - continuing without Doxygen support
checking for asciidoctor... no
configure: WARNING: asciidoctor not found - continuing without asciidoctor
support
checking for mscgen... no
configure: WARNING: mscgen not found - continuing without sequence message
support
checking for doxygen... no

Perhaps this change is needed to gnerate the above ?


With that patch the failure to build docs moved from the configure step to
the build step which is still fairly obvious

Making all in implementers-guide
make[2]: Entering directory '/root/git/odp/doc/implementers-guide'
asciidoctor -a data-uri -b html5 -a icons=font -a toc2
--out-file=implementers-guide.html implementers-guide.adoc
*make[2]: asciidoctor: Command not found*
Makefile:587: recipe for target 'implementers-guide.html' failed
make[2]: *** [implementers-guide.html] Error 127
make[2]: Leaving directory '/root/git/odp/doc/implementers-guide'
Makefile:442: recipe for target 'all-recursive' failed
make[1]: *** [all-recursive] Error 1
make[1]: Leaving directory '/root/git/odp/doc'
Makefile:492: recipe for target 'all-recursive' failed







>

> > +    case $DISTRIB_ID in

> > +        Arch) pkgs+="cunit " ;;

> > +        Ubuntu) ;&

> > +        Debian) pkgs+="libcunit1-dev " ;;

> > +    esac

> > +

> > +    case $DISTRIB_ID in

> > +        Arch) pkgs+="openssl " ;;

> > +        Ubuntu) ;&

> > +        Debian) pkgs+="libssl-dev " ;;

> > +        CentOS) ;&

> > +        RedHat) ;&

> > +        Fedora) pkgs+="openssl-devel " ;;

> > +    esac

> > +

> > +    case $DISTRIB_ID in

> > +        Arch) pkgs+="linux-headers " ;;

> > +    esac

> > +

> > +    case $DISTRIB_ID in

> > +        Arch) pkgs+="libpcap " ;;

> > +        Ubuntu) ;&

> > +        Debian) pkgs+="libpcap-dev " ;;

> > +    esac

> > +

> > +    # Uncomment for distro's version of netmap and dpdk

> > +    #pkgs+="netmap "

> > +    #pkgs+="dpdk "

> > +

> > +    pkgs+="valgrind "

> > +

> > +    case $DISTRIB_ID in

> > +        Arch) ;&

> > +        Ubuntu) ;&

> > +        Debian) pkgs+="codespell " ;;

> > +        # TODO: Install RPM repos for pip and post_install

> > +        # codespell via pip.

> > +        Fedora) ;&

> > +        RedHat) ;&

> > +        CentOS) ;;

> > +    esac

> > +

> > +    pkgmgr_install "$pkgs"

> > +

> > +    post_install

> > +}

> > +main "$@"

> > --

> > 1.8.3.1

> >

>




-- 
Mike Holmes
Program Manager - Linaro Networking Group
Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
"Work should be fun and collaborative, the rest follows"
diff mbox

Patch

diff --git a/doc/m4/configure.m4 b/doc/m4/configure.m4
index ed9451d..4393534 100644
--- a/doc/m4/configure.m4
+++ b/doc/m4/configure.m4
@@ -21,11 +21,7 @@  user_guides=no
 AC_ARG_ENABLE([user-guides],
     [  --enable-user-guides    generate supplemental users guides],
     [if test "x$enableval" = "xyes"; then
-        if test -z "$ASCIIDOCTOR";
-           then AC_MSG_ERROR([cannot generate user guides without
asciidoctor])
-        else
            user_guides=yes
-        fi
     fi])