From 4a4ca46ae29efc602d7e7f45a5221b0b74668796 Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Wed, 17 Jun 2020 23:29:32 +0200 Subject: [PATCH] doc: remove outdated guidelines for library addition There was a doc about how to extend DPDK by adding a library. It could have been useful but was never updated, so it is lacking a lot of explanations about doxygen, meson, versioning, maintainership, etc. Anyway such guidelines should fit in the contributors guide. Better to completely remove this obsolete document. Signed-off-by: Thomas Monjalon Acked-by: Bruce Richardson Acked-by: David Marchand --- doc/guides/prog_guide/extend_dpdk.rst | 109 -------------------------- doc/guides/prog_guide/index.rst | 1 - 2 files changed, 110 deletions(-) delete mode 100644 doc/guides/prog_guide/extend_dpdk.rst diff --git a/doc/guides/prog_guide/extend_dpdk.rst b/doc/guides/prog_guide/extend_dpdk.rst deleted file mode 100644 index a3b3d300b0..0000000000 --- a/doc/guides/prog_guide/extend_dpdk.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. SPDX-License-Identifier: BSD-3-Clause - Copyright(c) 2010-2014 Intel Corporation. - -Extending the DPDK -========================= - -This chapter describes how a developer can extend the DPDK to provide a new library, -a new target, or support a new target. - -Example: Adding a New Library libfoo ------------------------------------- - -To add a new library to the DPDK, proceed as follows: - -#. 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: - - .. code-block:: console - - mkdir ${RTE_SDK}/lib/libfoo - touch ${RTE_SDK}/lib/libfoo/foo.c - touch ${RTE_SDK}/lib/libfoo/foo.h - -#. Add a foo() function in libfoo. - - Definition is in foo.c: - - .. code-block:: c - - void foo(void) - { - } - - Declaration is in foo.h: - - .. code-block:: c - - extern void foo(void); - - -#. Update lib/Makefile: - - .. code-block:: console - - vi ${RTE_SDK}/lib/Makefile - # add: - # DIRS-$(CONFIG_RTE_LIBFOO) += libfoo - -#. Create a new Makefile for this library, for example, derived from mempool Makefile: - - .. code-block:: console - - cp ${RTE_SDK}/lib/librte_mempool/Makefile ${RTE_SDK}/lib/libfoo/ - - vi ${RTE_SDK}/lib/libfoo/Makefile - # replace: - # librte_mempool -> libfoo - # 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. - - -#. Build the DPDK with the new library (we only show a specific target here): - - .. code-block:: console - - cd ${RTE_SDK} - make config T=x86_64-native-linux-gcc - make - - -#. Check that the library is installed: - - .. code-block:: console - - ls build/lib - ls build/include - -Example: Using libfoo in the Test Application -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The test application is used to validate all functionality of the DPDK. -Once you have added a library, a new test case should be added in the test application. - -* A new test_foo.c file should be added, that includes foo.h and calls the foo() function from test_foo(). - When the test passes, the test_foo() function should return 0. - -* Makefile, test.h and commands.c must be updated also, to handle the new test case. - -* Test report generation: autotest.py is a script that is used to generate the test report that is available in the - ${RTE_SDK}/doc/rst/test_report/autotests directory. This script must be updated also. - If libfoo is in a new test family, the links in ${RTE_SDK}/doc/rst/test_report/test_report.rst must be updated. - -* Build the DPDK with the updated test application (we only show a specific target here): - - - .. code-block:: console - - cd ${RTE_SDK} - make config T=x86_64-native-linux-gcc - make diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst index 6f63f300af..8838ffb9ae 100644 --- a/doc/guides/prog_guide/index.rst +++ b/doc/guides/prog_guide/index.rst @@ -65,7 +65,6 @@ Programmer's Guide dev_kit_root_make_help build-sdk-meson meson_ut - extend_dpdk build_app ext_app_lib_make_help perf_opt_guidelines -- 2.20.1