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

Message ID 1496846277-280267-4-git-send-email-david.hunt@intel.com (mailing list archive)
State Rejected, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Hunt, David June 7, 2017, 2:37 p.m. UTC
  * 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(-)
  

Comments

John McNamara June 12, 2017, 12:50 p.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of David Hunt
> Sent: Wednesday, June 7, 2017 3:38 PM
> To: dev@dpdk.org
> Cc: thomas@monjalon.net; shreyansh.jain@nxp.com; Hunt, David
> <david.hunt@intel.com>
> Subject: [dpdk-dev] [PATCH v3 3/3] doc: update build-sdk-quick txt file
> 
>   * 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>

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Ferruh Yigit Feb. 13, 2018, 12:18 p.m. UTC | #2
On 6/12/2017 1:50 PM, Mcnamara, John wrote:
> 
> 
>> -----Original Message-----
>> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of David Hunt
>> Sent: Wednesday, June 7, 2017 3:38 PM
>> To: dev@dpdk.org
>> Cc: thomas@monjalon.net; shreyansh.jain@nxp.com; Hunt, David
>> <david.hunt@intel.com>
>> Subject: [dpdk-dev] [PATCH v3 3/3] doc: update build-sdk-quick txt file
>>
>>   * 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>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Thomas Monjalon Feb. 13, 2018, 11:41 p.m. UTC | #3
13/02/2018 13:18, Ferruh Yigit:
> On 6/12/2017 1:50 PM, Mcnamara, John wrote:
> >> -----Original Message-----
> >> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of David Hunt
> >> Sent: Wednesday, June 7, 2017 3:38 PM
> >> To: dev@dpdk.org
> >> Cc: thomas@monjalon.net; shreyansh.jain@nxp.com; Hunt, David
> >> <david.hunt@intel.com>
> >> Subject: [dpdk-dev] [PATCH v3 3/3] doc: update build-sdk-quick txt file
> >>
> >>   * 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>
> > 
> > Acked-by: John McNamara <john.mcnamara@intel.com>
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

I made some comments in patch 2 about RTE_TEMPLATE and got no reply
(in August).

This patch is dependent on RTE_TEMPLATE.

One more nit: the indent is broken for T variable explanation.
  
Hunt, David April 11, 2018, 8:44 a.m. UTC | #4
Hi Thomas


On 13/2/2018 11:41 PM, Thomas Monjalon wrote:
> 13/02/2018 13:18, Ferruh Yigit:
>> On 6/12/2017 1:50 PM, Mcnamara, John wrote:
>>>> -----Original Message-----
>>>> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of David Hunt
>>>> Sent: Wednesday, June 7, 2017 3:38 PM
>>>> To: dev@dpdk.org
>>>> Cc: thomas@monjalon.net; shreyansh.jain@nxp.com; Hunt, David
>>>> <david.hunt@intel.com>
>>>> Subject: [dpdk-dev] [PATCH v3 3/3] doc: update build-sdk-quick txt file
>>>>
>>>>    * 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>
>>> Acked-by: John McNamara <john.mcnamara@intel.com>
>> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
> I made some comments in patch 2 about RTE_TEMPLATE and got no reply
> (in August).

Since you correctly point out that "make install T=" is an old syntax, and
this variable only encourages this, let's drop this patch altogether.

There are two patches in patchwork relevant to this cahange, one is
the change, and the other is the docs update. There was a third part,
which was for the "make defconfig" functionality, which has already
been merged, including a portion of 25113, so both of the following
can be closed off.

http://dpdk.org/dev/patchwork/patch/25112/
http://dpdk.org/dev/patchwork/patch/25113/



> This patch is dependent on RTE_TEMPLATE.
>
> One more nit: the indent is broken for T variable explanation.
  
Thomas Monjalon April 11, 2018, 8:49 a.m. UTC | #5
11/04/2018 10:44, Hunt, David:
> On 13/2/2018 11:41 PM, Thomas Monjalon wrote:
> > I made some comments in patch 2 about RTE_TEMPLATE and got no reply
> > (in August).
> 
> Since you correctly point out that "make install T=" is an old syntax, and
> this variable only encourages this, let's drop this patch altogether.
> 
> There are two patches in patchwork relevant to this cahange, one is
> the change, and the other is the docs update. There was a third part,
> which was for the "make defconfig" functionality, which has already
> been merged, including a portion of 25113, so both of the following
> can be closed off.
> 
> http://dpdk.org/dev/patchwork/patch/25112/
> http://dpdk.org/dev/patchwork/patch/25113/

OK, thanks for the update.
  

Patch

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