From: Thomas Monjalon <thomas@monjalon.net>
To: dev@dpdk.org
Cc: david.marchand@redhat.com, bruce.richardson@intel.com,
John McNamara <john.mcnamara@intel.com>,
Marko Kovacevic <marko.kovacevic@intel.com>
Subject: [dpdk-dev] [PATCH 1/4] doc: remove outdated guidelines for library addition
Date: Thu, 18 Jun 2020 02:42:15 +0200 [thread overview]
Message-ID: <20200618004218.3730743-2-thomas@monjalon.net> (raw)
In-Reply-To: <20200618004218.3730743-1-thomas@monjalon.net>
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 <thomas@monjalon.net>
---
doc/guides/prog_guide/extend_dpdk.rst | 109 --------------------------
1 file changed, 109 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
--
2.26.2
next prev parent reply other threads:[~2020-06-18 0:42 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-18 0:42 [dpdk-dev] [PATCH 0/4] one more step in makefiles deprecation Thomas Monjalon
2020-06-18 0:42 ` Thomas Monjalon [this message]
2020-06-18 9:46 ` [dpdk-dev] [PATCH 1/4] doc: remove outdated guidelines for library addition Bruce Richardson
2020-06-18 0:42 ` [dpdk-dev] [PATCH 2/4] doc: remove build instructions where unneeded Thomas Monjalon
2020-06-18 1:10 ` Ajit Khaparde
2020-06-18 2:02 ` Chautru, Nicolas
2020-06-18 8:06 ` Thomas Monjalon
2020-06-18 2:16 ` Zhoujian (jay)
2020-06-18 9:48 ` Bruce Richardson
2020-06-18 0:42 ` [dpdk-dev] [PATCH 3/4] doc: update build instructions in the Linux guide Thomas Monjalon
2020-06-18 0:42 ` [dpdk-dev] [PATCH 4/4] mk: add a paused deprecation warning before each build Thomas Monjalon
2020-06-18 10:04 ` Bruce Richardson
2020-06-18 1:36 ` [dpdk-dev] [PATCH 0/4] one more step in makefiles deprecation Stephen Hemminger
2020-06-25 21:43 ` [dpdk-dev] [PATCH v2 " Thomas Monjalon
2020-06-25 21:43 ` [dpdk-dev] [PATCH v2 1/4] doc: remove outdated guidelines for library addition Thomas Monjalon
2020-06-25 21:43 ` [dpdk-dev] [PATCH v2 2/4] doc: remove build instructions where unneeded Thomas Monjalon
2020-06-25 21:43 ` [dpdk-dev] [PATCH v2 3/4] doc: update build instructions in the Linux guide Thomas Monjalon
2020-06-26 17:11 ` Bruce Richardson
2020-06-25 21:43 ` [dpdk-dev] [PATCH v2 4/4] mk: add a paused deprecation warning before each build Thomas Monjalon
2020-06-29 14:15 ` [dpdk-dev] [PATCH v2 0/4] one more step in makefiles deprecation David Marchand
2020-06-29 14:26 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200618004218.3730743-2-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=bruce.richardson@intel.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).