FM10K/dpdk-fm10k
FM10K/dpdk-fm10k
1
0
Fork 0
Code Issues Pull requests Releases Activity
dpdk-fm10k/doc/build-sdk-quick.txt

35 lines
1.5 KiB
Plaintext
Raw Permalink Normal View History

doc: how to build This is a cheat sheet to build DPDK and can be used for a "make help". It is explicitly described as a build help in order to concatenate it with other helps such as test commands. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com>
2013-05-07 15:00:52 +00:00
Basic build
mk: add sensible default target with defconfig Users can now use 'make defconfig' to generate a configuration using the most appropriate defaults for the current machine. <arch-machine-execenv-toolchain> arch taken from uname -m machine defaults to native execenv is taken from uname, Linux=linuxapp, otherwise bsdapp toolchain is taken from $CC -v to see which compiler to use Signed-off-by: David Hunt <david.hunt@intel.com> Acked-by: Shreyansh Jain <shreyansh.jain@nxp.com> Tested-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Acked-by: Thomas Monjalon <thomas@monjalon.net>
2017-08-04 10:39:02 +00:00
make defconfig && make
or
mk: use linux and freebsd in config names Rather than using linuxapp and bsdapp everywhere, we can change things to use the, more readable, terms "linux" and "freebsd" in our build configs. Rather than renaming the configs we can just duplicate the existing ones with the new names using symlinks, and use the new names exclusively internally. ["make showconfigs" also only shows the new names to keep the list short] The result is that backward compatibility is kept fully but any new builds or development can be done using the newer names, i.e. both "make config T=x86_64-native-linuxapp-gcc" and "T=x86_64-native-linux-gcc" work. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2019-03-06 16:22:42 +00:00
make config T=x86_64-native-linux-gcc && make
doc: how to build This is a cheat sheet to build DPDK and can be used for a "make help". It is explicitly described as a build help in order to concatenate it with other helps such as test commands. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com>
2013-05-07 15:00:52 +00:00
Build commands
mk: add "make examples" target in root makefile It is now possible to build all projects from the examples/ directory using one command from root directory. Some illustration of what is possible: - build examples in the DPDK tree for one target # install the x86_64-default-linuxapp-gcc in # ${RTE_SDK}/x86_64-default-linuxapp-gcc directory user@droids:~/dpdk.org$ make install T=x86_64-default-linuxapp-gcc # build examples for this new installation in # ${RTE_SDK}/examples directory user@droids:~/dpdk.org$ make examples T=x86_64-default-linuxapp-gcc - build examples outside DPDK tree for several targets # install all targets matching x86_64-*-linuxapp-gcc in # ${RTE_SDK}/x86_64-*-linuxapp-gcc directories user@droids:~/dpdk.org$ make install T=x86_64-*-linuxapp-gcc # build examples for these installations in /tmp/foobar user@droids:~/dpdk.org$ make examples T=x86_64-*-linuxapp-gcc O=/tmp/foobar Signed-off-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-05-16 08:19:01 +00:00
config get configuration from target template (T=)
mk: add sensible default target with defconfig Users can now use 'make defconfig' to generate a configuration using the most appropriate defaults for the current machine. <arch-machine-execenv-toolchain> arch taken from uname -m machine defaults to native execenv is taken from uname, Linux=linuxapp, otherwise bsdapp toolchain is taken from $CC -v to see which compiler to use Signed-off-by: David Hunt <david.hunt@intel.com> Acked-by: Shreyansh Jain <shreyansh.jain@nxp.com> Tested-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Acked-by: Thomas Monjalon <thomas@monjalon.net>
2017-08-04 10:39:02 +00:00
defconfig auto-select target template based on arch, OS, etc.
mk: add "make examples" target in root makefile It is now possible to build all projects from the examples/ directory using one command from root directory. Some illustration of what is possible: - build examples in the DPDK tree for one target # install the x86_64-default-linuxapp-gcc in # ${RTE_SDK}/x86_64-default-linuxapp-gcc directory user@droids:~/dpdk.org$ make install T=x86_64-default-linuxapp-gcc # build examples for this new installation in # ${RTE_SDK}/examples directory user@droids:~/dpdk.org$ make examples T=x86_64-default-linuxapp-gcc - build examples outside DPDK tree for several targets # install all targets matching x86_64-*-linuxapp-gcc in # ${RTE_SDK}/x86_64-*-linuxapp-gcc directories user@droids:~/dpdk.org$ make install T=x86_64-*-linuxapp-gcc # build examples for these installations in /tmp/foobar user@droids:~/dpdk.org$ make examples T=x86_64-*-linuxapp-gcc O=/tmp/foobar Signed-off-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-05-16 08:19:01 +00:00
all same as build (default rule)
build build in a configured directory
clean remove files but keep configuration
mk: introduce new install syntax The old install command was: make install T=x86_64-native-linuxapp-gcc DESTDIR=install It still works and can be replaced by these more standard commands: make config T=x86_64-native-linuxapp-gcc 0=x86_64-native-linuxapp-gcc make O=x86_64-native-linuxapp-gcc make install O=x86_64-native-linuxapp-gcc prefix= DESTDIR=install It means the "make install" do not perform any compilation anymore when T is not used. It is done only in pre_install to keep compatibility with the old syntax based on T= option. The default prefix /usr/local is empty in the T= case which is used only for a local install. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Panu Matilainen <pmatilai@redhat.com>
2015-12-01 14:04:01 +00:00
install T= configure, build and install a target in DESTDIR
install install optionally staged in DESTDIR
mk: add "make examples" target in root makefile It is now possible to build all projects from the examples/ directory using one command from root directory. Some illustration of what is possible: - build examples in the DPDK tree for one target # install the x86_64-default-linuxapp-gcc in # ${RTE_SDK}/x86_64-default-linuxapp-gcc directory user@droids:~/dpdk.org$ make install T=x86_64-default-linuxapp-gcc # build examples for this new installation in # ${RTE_SDK}/examples directory user@droids:~/dpdk.org$ make examples T=x86_64-default-linuxapp-gcc - build examples outside DPDK tree for several targets # install all targets matching x86_64-*-linuxapp-gcc in # ${RTE_SDK}/x86_64-*-linuxapp-gcc directories user@droids:~/dpdk.org$ make install T=x86_64-*-linuxapp-gcc # build examples for these installations in /tmp/foobar user@droids:~/dpdk.org$ make examples T=x86_64-*-linuxapp-gcc O=/tmp/foobar Signed-off-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-05-16 08:19:01 +00:00
examples build examples for given targets (T=)
examples_clean clean examples for given targets (T=)
doc: add test related rules in make help Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-02-16 14:57:46 +00:00
test compile tests and run basic unit tests
test-* run specific subset of unit tests
doc: add tags and cscope make targets to quick help Update the "make help" output to reflect the additions of make targets for tags database generation. Fixes: aafaea3d3b70 ("devtools: add tags and cscope index generation") Signed-off-by: Gabriel Carrillo <erik.g.carrillo@intel.com> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
2017-07-07 17:09:59 +00:00
tags|etags|gtags generate tags database for given targets (T=)
cscope generate cscope database for given targets (T=)
doc: how to build This is a cheat sheet to build DPDK and can be used for a "make help". It is explicitly described as a build help in order to concatenate it with other helps such as test commands. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com>
2013-05-07 15:00:52 +00:00
Build variables
EXTRA_CPPFLAGS preprocessor options
EXTRA_CFLAGS compiler options
EXTRA_LDFLAGS linker options
mk: introduce EXTRA_LDLIBS variable Signed-off-by: Keith Wiles <keith.wiles@intel.com> Acked-by: Olivier Matz <olivier.matz@6wind.com>
2015-05-14 14:21:32 +00:00
EXTRA_LDLIBS linker library options
doc: how to build This is a cheat sheet to build DPDK and can be used for a "make help". It is explicitly described as a build help in order to concatenate it with other helps such as test commands. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com>
2013-05-07 15:00:52 +00:00
RTE_KERNELDIR linux headers path
mk: stop on warning only in developer build Add RTE_DEVEL_BUILD make-variable which can be used to do things differently when doing development vs building a release, autodetected from source root .git presence and overridable via commandline. It is used it to enable -Werror compiler flag and may be extended to other checks. Failing build on warnings is a useful developer tool but its bad for release tarballs which can and do get built with newer compilers than what was used/available during development. Compilers routinely add new warnings so code which built silently with cc X might no longer do so with X+1. This doesn't make the existing code any more buggier and failing the build in this case does not help to improve the quality of an already released version either. This change the default flags which can be tuned with EXTRA_CFLAGS. Signed-off-by: Panu Matilainen <pmatilai@redhat.com> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2015-02-12 15:18:20 +00:00
RTE_DEVEL_BUILD stricter options (default: y in git tree)
mk: allow to specify DESTDIR in build rule This will install the binary sdk (bin + modules + libs + headers + mk) in the specified directory. This directory can be used as RTE_SDK by external applications. Signed-off-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2013-01-30 15:32:15 +00:00
CROSS toolchain prefix
V verbose
D debug dependencies
mk: introduce new install syntax The old install command was: make install T=x86_64-native-linuxapp-gcc DESTDIR=install It still works and can be replaced by these more standard commands: make config T=x86_64-native-linuxapp-gcc 0=x86_64-native-linuxapp-gcc make O=x86_64-native-linuxapp-gcc make install O=x86_64-native-linuxapp-gcc prefix= DESTDIR=install It means the "make install" do not perform any compilation anymore when T is not used. It is done only in pre_install to keep compatibility with the old syntax based on T= option. The default prefix /usr/local is empty in the T= case which is used only for a local install. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Panu Matilainen <pmatilai@redhat.com>
2015-12-01 14:04:01 +00:00
O build directory (default: build/ - install T= default: ./)
doc: add default values of install variables The variables DESTDIR and prefix are used with "make install" to copy the files in $DESTDIR$prefix. Their default values will be shown when calling "make help". Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-02-17 15:55:40 +00:00
DESTDIR staging install directory (default: empty)
prefix root install directory (default: /usr/local)
mk: remove multi-target install The multi-target install create some subdirectories with the target name which is not standard for a "make install" procedure. The uninstall procedure cannot be applied properly (without removing all files in a directory). It would need to pre-compute paths. As it is a packaging issue, it is removed from the build system capabilities. The variable BUILD_DIR is also renamed to RTE_OUTPUT used in other files. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Panu Matilainen <pmatilai@redhat.com>
2015-12-01 07:36:00 +00:00
T target template - used with config or install
doc: how to build This is a cheat sheet to build DPDK and can be used for a "make help". It is explicitly described as a build help in order to concatenate it with other helps such as test commands. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com>
2013-05-07 15:00:52 +00:00
format: <arch-machine-execenv-toolchain>
templates in config/defconfig_*
Reference in a new issue Copy permalink