From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <david.hunt@intel.com>
Received: from mga07.intel.com (mga07.intel.com [134.134.136.100])
 by dpdk.org (Postfix) with ESMTP id 642D02C2F
 for <dev@dpdk.org>; Wed,  7 Jun 2017 16:38:08 +0200 (CEST)
Received: from orsmga001.jf.intel.com ([10.7.209.18])
 by orsmga105.jf.intel.com with ESMTP; 07 Jun 2017 07:38:07 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.39,311,1493708400"; d="scan'208";a="1138912810"
Received: from silpixa00397898.ir.intel.com ([10.237.223.116])
 by orsmga001.jf.intel.com with ESMTP; 07 Jun 2017 07:38:06 -0700
From: David Hunt <david.hunt@intel.com>
To: dev@dpdk.org
Cc: thomas@monjalon.net, shreyansh.jain@nxp.com,
 David Hunt <david.hunt@intel.com>
Date: Wed,  7 Jun 2017 15:37:57 +0100
Message-Id: <1496846277-280267-4-git-send-email-david.hunt@intel.com>
X-Mailer: git-send-email 2.7.4
In-Reply-To: <1496846277-280267-1-git-send-email-david.hunt@intel.com>
References: <1495788764-37652-2-git-send-email-david.hunt@intel.com>
 <1496846277-280267-1-git-send-email-david.hunt@intel.com>
Subject: [dpdk-dev] [PATCH v3 3/3] doc: update build-sdk-quick txt file
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 07 Jun 2017 14:38:08 -0000

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