summaryrefslogtreecommitdiff
path: root/doc/guides/prog_guide/dev_kit_root_make_help.rst
blob: a30db7d5b40dd56c71a1a3a9e765f9612338576f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
..  SPDX-License-Identifier: BSD-3-Clause
    Copyright(c) 2010-2014 Intel Corporation.

.. _Development_Kit_Root_Makefile_Help:

Development Kit Root Makefile Help
==================================

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
---------------------

The configuration target requires the name of the target, which is specified using T=mytarget and it is mandatory.
The list of available targets are in $(RTE_SDK)/config (remove the defconfig _ prefix).

Configuration targets also support the specification of the name of the output directory, using O=mybuilddir.
This is an optional parameter, the default output directory is build.

*   Config

    This will create a build directory, and generates a configuration from a template.
    A Makefile is also created in the new build directory.

    Example:

    .. code-block:: console

        make config O=mybuild T=x86_64-native-linux-gcc

Build Targets
-------------

Build targets support the optional specification of the name of the output directory, using O=mybuilddir.
The default output directory is build.

*   all, build or just make

    Build the DPDK in the output directory previously created by a make config.

    Example:

    .. code-block:: console

        make O=mybuild

*   clean

    Clean all objects created using make build.

    Example:

    .. code-block:: console

        make clean O=mybuild

*   %_sub

    Build a subdirectory only, without managing dependencies on other directories.

    Example:

    .. code-block:: console

        make lib/librte_eal_sub O=mybuild

*   %_clean

    Clean a subdirectory only.

    Example:

    .. code-block:: console

        make lib/librte_eal_clean O=mybuild

Install Targets
---------------

*   Install

    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 DESTDIR=myinstall prefix=/usr

Test Targets
------------

*   test

    Launch automatic tests for a build directory specified using O=mybuilddir.
    It is optional, the default output directory is build.

    Example:

    .. code-block:: console

        make test O=mybuild

Documentation Targets
---------------------

*   doc

    Generate the documentation (API and guides).

*   doc-api-html

    Generate the Doxygen API documentation in html.

*   doc-guides-html

    Generate the guides documentation in html.

*   doc-guides-pdf

    Generate the guides documentation in pdf.

Misc Targets
------------

*   help

    Show a quick help.

Other Useful Command-line Variables
-----------------------------------

The following variables can be specified on the command line:

*   V=

    Enable verbose build (show full compilation command line, and some intermediate commands).

*   D=

    Enable dependency debugging. This provides some useful information about why a target is built or not.

*   EXTRA_CFLAGS=, EXTRA_LDFLAGS=, EXTRA_LDLIBS=, EXTRA_ASFLAGS=, EXTRA_CPPFLAGS=

    Append specific compilation, link or asm flags.

*   CROSS=

    Specify a cross toolchain header that will prefix all gcc/binutils applications. This only works when using gcc.

Make in a Build Directory
-------------------------

All targets described above are called from the SDK root $(RTE_SDK).
It is possible to run the same Makefile targets inside the build directory.
For instance, the following command:

.. code-block:: console

    cd $(RTE_SDK)
    make config O=mybuild T=x86_64-native-linux-gcc
    make O=mybuild

is equivalent to:

.. code-block:: console

    cd $(RTE_SDK)
    make config O=mybuild T=x86_64-native-linux-gcc
    cd mybuild

    # no need to specify O= now
    make

Compiling for Debug
-------------------

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'