[dpdk-dev] [PATCH v2 1/3] doc: how to build

[Thomas Monjalon <thomas.monjalon@6wind.com>]

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>
---
 doc/build-sdk-quick.txt |   20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 doc/build-sdk-quick.txt

diff --git a/doc/build-sdk-quick.txt b/doc/build-sdk-quick.txt
new file mode 100644
index 0000000..c839676
--- /dev/null
+++ b/doc/build-sdk-quick.txt
@@ -0,0 +1,20 @@
+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
+	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_*
-- 
1.7.10.4