X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fsample_app_ug%2Fcompiling.rst;h=adde775d4e90403ead694fc1ffcf96e3f68c8828;hb=db27370b57202632ad8830352c1c0ee2dde4542f;hp=8bedaa79b0079273740be0a527e7f31c83d57f34;hpb=7cacb05655397c0c50bcba89eb836d417bc78b69;p=dpdk.git diff --git a/doc/guides/sample_app_ug/compiling.rst b/doc/guides/sample_app_ug/compiling.rst index 8bedaa79b0..adde775d4e 100644 --- a/doc/guides/sample_app_ug/compiling.rst +++ b/doc/guides/sample_app_ug/compiling.rst @@ -1,32 +1,5 @@ - .. BSD LICENSE - Copyright(c) 2015 Intel Corporation. All rights reserved. - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - * Neither the name of Intel Corporation nor the names of its - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2015 Intel Corporation. Compiling the Sample Applications ================================= @@ -36,87 +9,75 @@ This section explains how to compile the DPDK sample applications. To compile all the sample applications -------------------------------------- - -Set the path to DPDK source code if its not set: - - .. code-block:: console - - export RTE_SDK=/path/to/rte_sdk - -Go to DPDK source: +Go to DPDK build directory: .. code-block:: console - cd $RTE_SDK + cd dpdk/ -Build DPDK: +Enable examples compilation: .. code-block:: console - make defconfig - make + meson configure -Dexamples=all -Build the sample applications: +Build: .. code-block:: console - export RTE_TARGET=build - make -C examples + ninja -For other possible ``RTE_TARGET`` values and additional information on -compiling see +For additional information on compiling see :ref:`Compiling DPDK on Linux ` or :ref:`Compiling DPDK on FreeBSD `. -Applications are output to: ``$RTE_SDK/examples/app-dir/build`` or -``$RTE_SDK/examples/app-dir/$RTE_TARGET``. +Applications are output to: ``dpdk//examples``. -In the example above the compiled application is written to the ``build`` subdirectory. -To have the applications written to a different location, -the ``O=/path/to/build/directory`` option may be specified in the make command. +To compile a single application +------------------------------- - .. code-block:: console - make O=/tmp +Using meson +~~~~~~~~~~~ -To build the applications for debugging use the ``DEBUG`` option. -This option adds some extra flags, disables compiler optimizations and -sets verbose output. +Go to DPDK build directory: .. code-block:: console - make DEBUG=1 - - -To compile a single application -------------------------------- + cd dpdk/ -Set the path to DPDK source code: +Enable example app compilation: - .. code-block:: console + .. code-block:: console - export RTE_SDK=/path/to/rte_sdk + meson configure -Dexamples=helloworld -Go to DPDK source: +Build: - .. code-block:: console + .. code-block:: console - cd $RTE_SDK + ninja -Build DPDK: - .. code-block:: console +Using Make +~~~~~~~~~~ - make defconfig - make +Pkg-config is used when building an example app standalone using make, please +see :ref:`building_app_using_installed_dpdk` for more information. Go to the sample application directory. Unless otherwise specified the sample -applications are located in ``$RTE_SDK/examples/``. - +applications are located in ``dpdk/examples/``. Build the application: .. code-block:: console - export RTE_TARGET=build make + +To build the application for debugging use the ``DEBUG`` option. +This option adds some extra flags, disables compiler optimizations and +sets verbose output. + + .. code-block:: console + + make DEBUG=1