From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <olivier.matz@6wind.com>
Received: from mail.droids-corp.org (zoll.droids-corp.org [94.23.50.67])
 by dpdk.org (Postfix) with ESMTP id 613D121D
 for <dev@dpdk.org>; Fri, 17 May 2013 11:03:26 +0200 (CEST)
Received: from was59-1-82-226-113-214.fbx.proxad.net ([82.226.113.214]
 helo=[192.168.0.11]) by mail.droids-corp.org with esmtpsa
 (TLS1.0:DHE_RSA_CAMELLIA_256_CBC_SHA1:256) (Exim 4.80)
 (envelope-from <olivier.matz@6wind.com>) id 1UdGaN-00051M-5y
 for dev@dpdk.org; Fri, 17 May 2013 11:04:26 +0200
Message-ID: <5195F303.2080004@6wind.com>
Date: Fri, 17 May 2013 11:06:11 +0200
From: Olivier MATZ <olivier.matz@6wind.com>
User-Agent: Mozilla/5.0 (X11; Linux x86_64;
 rv:10.0.12) Gecko/20130116 Icedove/10.0.12
MIME-Version: 1.0
To: dev@dpdk.org
References: <cover.1367939814.git.thomas.monjalon@6wind.com>
 <fa5bbf77e53cbef7f33b49b1e8b01e960d0ce4c1.1367939814.git.thomas.monjalon@6wind.com>
In-Reply-To: <fa5bbf77e53cbef7f33b49b1e8b01e960d0ce4c1.1367939814.git.thomas.monjalon@6wind.com>
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Subject: Re: [dpdk-dev] [PATCH 2/3] doc: how to build
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <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: Fri, 17 May 2013 09:03:26 -0000

Hi Thomas,

Good to see a "make help" ;)

What do you think of replacing "Build options" by "Build variables" ?
I think it is not obvious that we have to use V=1 for instance for
a verbose build.

About the "build targets", I suggest to include it in the help of T
variable. What do you think ?

Olivier

On 05/07/2013 05:17 PM, Thomas Monjalon wrote:
> 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 |   22 ++++++++++++++++++++++
>  1 file changed, 22 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..3f88522
> --- /dev/null
> +++ b/doc/build-sdk-quick.txt
> @@ -0,0 +1,22 @@
> +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 options
> +	T   target template (install default: *) - used with config or install
> +	O   output directory (default: build/)   - cannot be used with install
> +	V   verbose
> +	D   debug dependencies
> +	CROSS            toolchain prefix
> +	EXTRA_CPPFLAGS   preprocessor options
> +	EXTRA_CFLAGS     compiler options
> +	EXTRA_LDFLAGS    linker options
> +Build targets
> +	format: <arch-machine-execenv-toolchain>
> +	templates in config/defconfig_*:
> +		# make showconfigs