* Install
- Build the DPDK binary.
- Actually, this builds each supported target in a separate directory.
- The name of each directory is the name of the target.
- The name of the targets to install can be optionally specified using T=mytarget.
- The target name can contain wildcard \* characters.
The list of available targets are in $(RTE_SDK)/config (remove the defconfig\_ prefix).
+ The GNU standards variables may be used:
+ http://gnu.org/prep/standards/html_node/Directory-Variables.html and
+ http://gnu.org/prep/standards/html_node/DESTDIR.html
+
Example:
.. code-block:: console
- make install T=x86_64-*
-
-* Uninstall
-
- Remove installed target directories.
+ make install DESTDIR=myinstall prefix=/usr
Test Targets
------------
make test O=mybuild
-* testall
-
- Launch automatic tests for all installed target directories (after a make install).
- The name of the targets to test can be optionally specified using T=mytarget.
- The target name can contain wildcard (\*) characters.
- The list of available targets are in $(RTE_SDK)/config (remove the defconfig\_ prefix).
-
- Examples:
-
- .. code-block:: console
-
- make testall, make testall T=x86_64-*
-
Documentation Targets
---------------------
-* doxydoc
+* doc
- Generate the Doxygen documentation (pdf only).
+ Generate the documentation (API and guides).
-Deps Targets
-------------
+* doc-api-html
-* depdirs
+ Generate the Doxygen API documentation in html.
- This target is implicitly called by make config.
- Typically, there is no need for a user to call it,
- except if DEPDIRS-y variables have been updated in Makefiles.
- It will generate the file $(RTE_OUTPUT)/.depdirs.
+* doc-guides-html
- Example:
+ Generate the guides documentation in html.
- .. code-block:: console
+* doc-guides-pdf
- make depdirs O=mybuild
-
-* depgraph
-
- This command generates a dot graph of dependencies.
- It can be displayed to debug circular dependency issues, or just to understand the dependencies.
-
- Example:
-
- .. code-block:: console
-
- make depgraph O=mybuild > /tmp/graph.dot && dotty /tmp/ graph.dot
+ Generate the guides documentation in pdf.
Misc Targets
------------
* help
- Show this help.
+ Show a quick help.
Other Useful Command-line Variables
-----------------------------------
Enable dependency debugging. This provides some useful information about why a target is built or not.
-* EXTRA_CFLAGS=, EXTRA_LDFLAGS=, EXTRA_ASFLAGS=, EXTRA_CPPFLAGS=
+* EXTRA_CFLAGS=, EXTRA_LDFLAGS=, EXTRA_LDLIBS=, EXTRA_ASFLAGS=, EXTRA_CPPFLAGS=
Append specific compilation, link or asm flags.
.. code-block:: console
export EXTRA_CFLAGS='-O0 -g'
-
-The DPDK and any user or sample applications can then be compiled in the usual way.
-For example:
-
-.. code-block:: console
-
- make install T=x86_64-native-linuxapp-gcc make -C examples/<theapp>