doc/guides/testpmd_app_ug/build_app.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     * Redistributions of source code must retain the above copyright
  10     notice, this list of conditions and the following disclaimer.
  11     * Redistributions in binary form must reproduce the above copyright
  12     notice, this list of conditions and the following disclaimer in
  13     the documentation and/or other materials provided with the
  14     distribution.
  15     * Neither the name of Intel Corporation nor the names of its
  16     contributors may be used to endorse or promote products derived
  17     from this software without specific prior written permission.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 Compiling the Application
  32 =========================
  33
  34 The ``testpmd`` application is compiled as part of the main compilation of the DPDK libraries and tools.
  35 Refer to the DPDK Getting Started Guides for details.
  36 The basic compilation steps are:
  37
  38 #.  Set the required environmental variables and go to the source directory:
  39
  40     .. code-block:: console
  41
  42         export RTE_SDK=/path/to/rte_sdk
  43         cd $RTE_SDK
  44
  45 #.  Set the compilation target. For example:
  46
  47     .. code-block:: console
  48
  49         export RTE_TARGET=x86_64-native-linuxapp-gcc
  50
  51 #.  Build the application:
  52
  53     .. code-block:: console
  54
  55         make install T=$RTE_TARGET
  56
  57     The compiled application will be located at:
  58
  59     .. code-block:: console
  60
  61         $RTE_SDK/$RTE_TARGET/build/app/testpmd