X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=doc%2Fguides%2Fprog_guide%2Fextend_dpdk.rst;h=725994ee09c18969833da763b4d2bc0644c4db5b;hb=ca33590b6af032bff57d9cc70455660466a654b2;hp=51f0b5c29eab5c0de669d7adc87a624c7cadbab4;hpb=97f17497d162afdb82c8704bf097f0fee3724b2e;p=deb_dpdk.git diff --git a/doc/guides/prog_guide/extend_dpdk.rst b/doc/guides/prog_guide/extend_dpdk.rst index 51f0b5c2..725994ee 100644 --- a/doc/guides/prog_guide/extend_dpdk.rst +++ b/doc/guides/prog_guide/extend_dpdk.rst @@ -1,32 +1,5 @@ -.. BSD LICENSE - Copyright(c) 2010-2014 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) 2010-2014 Intel Corporation. Extending the DPDK ========================= @@ -39,14 +12,14 @@ Example: Adding a New Library libfoo To add a new library to the DPDK, proceed as follows: -#. Add a new configuration option: +#. Add a new configuration option: .. code-block:: bash for f in config/\*; do \ echo CONFIG_RTE_LIBFOO=y >> $f; done -#. Create a new directory with sources: +#. Create a new directory with sources: .. code-block:: console @@ -54,7 +27,7 @@ To add a new library to the DPDK, proceed as follows: touch ${RTE_SDK}/lib/libfoo/foo.c touch ${RTE_SDK}/lib/libfoo/foo.h -#. Add a foo() function in libfoo. +#. Add a foo() function in libfoo. Definition is in foo.c: @@ -71,7 +44,7 @@ To add a new library to the DPDK, proceed as follows: extern void foo(void); -#. Update lib/Makefile: +#. Update lib/Makefile: .. code-block:: console @@ -79,7 +52,7 @@ To add a new library to the DPDK, proceed as follows: # add: # DIRS-$(CONFIG_RTE_LIBFOO) += libfoo -#. Create a new Makefile for this library, for example, derived from mempool Makefile: +#. Create a new Makefile for this library, for example, derived from mempool Makefile: .. code-block:: console @@ -91,11 +64,11 @@ To add a new library to the DPDK, proceed as follows: # rte_mempool -> foo -#. Update mk/DPDK.app.mk, and add -lfoo in LDLIBS variable when the option is enabled. - This will automatically add this flag when linking a DPDK application. +#. Update mk/DPDK.app.mk, and add -lfoo in LDLIBS variable when the option is enabled. + This will automatically add this flag when linking a DPDK application. -#. Build the DPDK with the new library (we only show a specific target here): +#. Build the DPDK with the new library (we only show a specific target here): .. code-block:: console @@ -104,7 +77,7 @@ To add a new library to the DPDK, proceed as follows: make -#. Check that the library is installed: +#. Check that the library is installed: .. code-block:: console