[dpdk-dev] [PATCH v3 3/3] doc: update build-sdk-quick txt file

David Hunt david.hunt at intel.com
Wed Jun 7 16:37:57 CEST 2017


  * Add in information about 'make defconfig'
  * Add in information about RTE_TEMPLATE environment variable
  * Explain the default directory for 'O=' a bit better
  * Clean up text alignment

Signed-off-by: David Hunt <david.hunt at intel.com>
---
 doc/build-sdk-quick.txt | 28 +++++++++++++++++++---------
 1 file changed, 19 insertions(+), 9 deletions(-)

diff --git a/doc/build-sdk-quick.txt b/doc/build-sdk-quick.txt
index 8d41052..79f6971 100644
--- a/doc/build-sdk-quick.txt
+++ b/doc/build-sdk-quick.txt
@@ -1,7 +1,10 @@
 Basic build
+	make defconfig && make
+	or
 	make config T=x86_64-native-linuxapp-gcc && make
 Build commands
 	config           get configuration from target template (T=)
+	defconfig        auto-select target template based on arch, OS, etc.
 	all              same as build (default rule)
 	build            build in a configured directory
 	clean            remove files but keep configuration
@@ -18,12 +21,19 @@ Build variables
 	EXTRA_LDLIBS     linker library options
 	RTE_KERNELDIR    linux headers path
 	RTE_DEVEL_BUILD  stricter options (default: y in git tree)
-	CROSS     toolchain prefix
-	V         verbose
-	D         debug dependencies
-	O         build directory (default: build/ - install T= default: ./)
-	DESTDIR   staging install directory (default: empty)
-	prefix    root install directory (default: /usr/local)
-	T         target template - used with config or install
-			format: <arch-machine-execenv-toolchain>
-			templates in config/defconfig_*
+	CROSS            toolchain prefix
+	V                verbose
+	D                debug dependencies
+	O                build directory (default different depending on use):
+	                          make defconfig,     default: build/
+	                          make config T=xyz,  default: build/
+	                          make,               default: build/
+	                          make install T=xyz, default: xyz/
+	DESTDIR          staging install directory (default: empty)
+	prefix           root install directory (default: /usr/local)
+	T                target template - used with config or install
+	                 format: <arch-machine-execenv-toolchain>
+	                 templates in config/defconfig_*
+	RTE_TEMPLATE     Set this as an environment variable to replace (T=)
+	                 Example: export RTE_TEMPLATE=x86_64-native-linuxapp-gcc
+	                          make config && make
-- 
2.7.4



More information about the dev mailing list