mbuf: remove control mbuf
[dpdk.git] / doc / guides / prog_guide / dev_kit_root_make_help.rst
index b410674..d7c4106 100644 (file)
@@ -33,7 +33,7 @@
 Development Kit Root Makefile Help
 ==================================
 
-The Intel® DPDK provides a root level Makefile with targets for configuration, building, cleaning, testing, installation and others.
+The DPDK provides a root level Makefile with targets for configuration, building, cleaning, testing, installation and others.
 These targets are explained in the following sections.
 
 Configuration Targets
@@ -64,7 +64,7 @@ The default output directory is build.
 
 *   all, build or just make
 
-    Build the Intel® DPDK in the output directory previously created by a make config.
+    Build the DPDK in the output directory previously created by a make config.
 
     Example:
 
@@ -107,22 +107,17 @@ Install Targets
 
 *   Install
 
-    Build the Intel® 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
 ------------
@@ -138,59 +133,31 @@ 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
 -----------------------------------
@@ -205,7 +172,7 @@ The following variables can be specified on the command line:
 
     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.
 
@@ -240,16 +207,9 @@ is equivalent to:
 Compiling for Debug
 -------------------
 
-To compile the Intel® DPDK and sample applications with debugging information included and the optimization level set to 0,
+To compile the DPDK and sample applications with debugging information included and the optimization level set to 0,
 the EXTRA_CFLAGS environment variable should be set before compiling as follows:
 
 .. code-block:: console
 
     export EXTRA_CFLAGS='-O0 -g'
-
-The Intel® 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>