summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas Monjalon <thomas.monjalon@6wind.com>2013-05-07 17:00:52 +0200
committerThomas Monjalon <thomas.monjalon@6wind.com>2013-11-24 21:31:36 +0100
commitc8559fffdabd6500a70015c63ceb49495c09b1e6 (patch)
tree7f238837b89f0fd8da966c2ecb605f11f7e4f243 /doc
parented86b164621de1a32c8c7e691706ba19e9b5d2f0 (diff)
downloaddpdk-c8559fffdabd6500a70015c63ceb49495c09b1e6.zip
dpdk-c8559fffdabd6500a70015c63ceb49495c09b1e6.tar.gz
dpdk-c8559fffdabd6500a70015c63ceb49495c09b1e6.tar.xz
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/build-sdk-quick.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/build-sdk-quick.txt b/doc/build-sdk-quick.txt
new file mode 100644
index 0000000..3780dec
--- /dev/null
+++ b/doc/build-sdk-quick.txt
@@ -0,0 +1,21 @@
+Basic build
+ make config T=x86_64-default-linuxapp-gcc && make
+Build commands
+ config get configuration from target template (T=)
+ all same as build (default rule)
+ build build in a configured directory
+ clean remove files but keep configuration
+ install build many targets (wildcard allowed) in fixed directories
+ uninstall remove all installed targets
+Build variables
+ CROSS toolchain prefix
+ EXTRA_CPPFLAGS preprocessor options
+ EXTRA_CFLAGS compiler options
+ EXTRA_LDFLAGS linker options
+ RTE_KERNELDIR linux headers path
+ V verbose
+ D debug dependencies
+ O output directory (default: build/) - cannot be used with install
+ T target template (install default: *) - used with config or install
+ format: <arch-machine-execenv-toolchain>
+ templates in config/defconfig_*