[dpdk-web] [PATCH] update quick start page

[dpdk-web] [PATCH] update quick start page

[Thomas Monjalon]

Use meson instead of make.
Remove -n EAL option.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 content/doc/quick-start.md | 20 ++++----------------
 1 file changed, 4 insertions(+), 16 deletions(-)

diff --git a/content/doc/quick-start.md b/content/doc/quick-start.md
index fdffa98..1ecc8b8 100644
--- a/content/doc/quick-start.md
+++ b/content/doc/quick-start.md
@@ -11,17 +11,11 @@ Extract sources
   cd dpdk
 ```
 
-Enable pcap (libpcap headers are required).
+Build libraries, tests and examples applications.
 
 ```
-  make config T=x86_64-native-linuxapp-gcc
-  sed -ri 's,(PMD_PCAP=).*,\1y,' build/.config
-```
-
-Build libraries and test application (Linux headers may be needed with default config).
-
-```
-  make
+  meson -Dexamples=all build
+  ninja -C build
 ```
 
 Reserve huge pages memory.
@@ -35,7 +29,7 @@ Reserve huge pages memory.
 Run poll-mode driver test (with a cable between ports).
 
 ```
-  build/app/testpmd -c7 -n3 --vdev=net_pcap0,iface=eth0     --vdev=net_pcap1,iface=eth1 --
+  build/app/dpdk-testpmd -c7 --vdev=net_pcap0,iface=eth0 --vdev=net_pcap1,iface=eth1 --
                   -i --nb-cores=2 --nb-ports=2 --total-num-mbufs=2048
 
   testpmd> show port stats all
@@ -69,9 +63,3 @@ Run poll-mode driver test (with a cable between ports).
   TX-packets: 4384729        TX-dropped: 0             TX-total: 4384729
   ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 ```
-
-Some sample applications can be tested after building them.
-
-```
-  make -C examples RTE_SDK=$(pwd) RTE_TARGET=build O=$(pwd)/build/examples
-```
-- 
2.26.2

Re: [dpdk-web] [PATCH] update quick start page

[Richardson, Bruce]

> -----Original Message-----
> From: web <web-bounces@dpdk.org> On Behalf Of Thomas Monjalon
> Sent: Wednesday, June 17, 2020 9:37 PM
> To: web@dpdk.org
> Subject: [dpdk-web] [PATCH] update quick start page
> 
> Use meson instead of make.
> Remove -n EAL option.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  content/doc/quick-start.md | 20 ++++----------------
>  1 file changed, 4 insertions(+), 16 deletions(-)
> 
> diff --git a/content/doc/quick-start.md b/content/doc/quick-start.md index
> fdffa98..1ecc8b8 100644
> --- a/content/doc/quick-start.md
> +++ b/content/doc/quick-start.md
> @@ -11,17 +11,11 @@ Extract sources
>    cd dpdk
>  ```
> 
> -Enable pcap (libpcap headers are required).
> +Build libraries, tests and examples applications.
> 
>  ```
> -  make config T=x86_64-native-linuxapp-gcc
> -  sed -ri 's,(PMD_PCAP=).*,\1y,' build/.config -```
> -
> -Build libraries and test application (Linux headers may be needed with
> default config).
> -
> -```
> -  make
> +  meson -Dexamples=all build

Do we really want building all examples to be part of the default instructions? It will lead to a longer build time?
I think we should give initial instructions just with meson build, and then afterwards show building examples.

Re: [dpdk-web] [PATCH] update quick start page

[Thomas Monjalon]

18/06/2020 10:21, Richardson, Bruce:
> From: Thomas Monjalon
> > --- a/content/doc/quick-start.md
> > +++ b/content/doc/quick-start.md
> > -  make
> > +  meson -Dexamples=all build
> 
> Do we really want building all examples to be part of the default instructions? It will lead to a longer build time?
> I think we should give initial instructions just with meson build, and then afterwards show building examples.

How do you suggest is the best to compile examples in a second step?
	meson configure -Dexamples=all ?

Re: [dpdk-web] [PATCH] update quick start page

[Richardson, Bruce]

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Thursday, June 18, 2020 9:50 AM
> To: Richardson, Bruce <bruce.richardson@intel.com>
> Cc: web@dpdk.org
> Subject: Re: [dpdk-web] [PATCH] update quick start page
> 
> 18/06/2020 10:21, Richardson, Bruce:
> > From: Thomas Monjalon
> > > --- a/content/doc/quick-start.md
> > > +++ b/content/doc/quick-start.md
> > > -  make
> > > +  meson -Dexamples=all build
> >
> > Do we really want building all examples to be part of the default
> instructions? It will lead to a longer build time?
> > I think we should give initial instructions just with meson build, and
> then afterwards show building examples.
> 
> How do you suggest is the best to compile examples in a second step?
> 	meson configure -Dexamples=all ?
> 
> 

No rather than an additional step, I think showing it as an alternative set
of instructions might work well. Something like:

"""
To build the DPDK libraries, drivers and test applications use:

meson build
ninja -C build

To include the examples as part of the build, the -Dexamples flag can be
passed to meson, with a comma-separated list of the desired examples, or
'all' to indicate all buildable examples. For example:

meson -Dexamples=all build
ninja -C build
"""

Re: [dpdk-web] [PATCH] update quick start page

[Thomas Monjalon]

18/06/2020 11:07, Richardson, Bruce:
> From: Thomas Monjalon <thomas@monjalon.net>
> > 18/06/2020 10:21, Richardson, Bruce:
> > > From: Thomas Monjalon
> > > > --- a/content/doc/quick-start.md
> > > > +++ b/content/doc/quick-start.md
> > > > -  make
> > > > +  meson -Dexamples=all build
> > >
> > > Do we really want building all examples to be part of the default
> > instructions? It will lead to a longer build time?
> > > I think we should give initial instructions just with meson build, and
> > then afterwards show building examples.
> > 
> > How do you suggest is the best to compile examples in a second step?
> > 	meson configure -Dexamples=all ?
> > 
> > 
> 
> No rather than an additional step, I think showing it as an alternative set
> of instructions might work well. Something like:
> 
> """
> To build the DPDK libraries, drivers and test applications use:
> 
> meson build
> ninja -C build
> 
> To include the examples as part of the build, the -Dexamples flag can be
> passed to meson, with a comma-separated list of the desired examples, or
> 'all' to indicate all buildable examples. For example:
> 
> meson -Dexamples=all build
> ninja -C build
> """

I avoid such long sentence in a quick start guide.
What about this?

"
To include the examples as part of the build,
replace the meson command with:

meson -Dexamples=all build
"

Re: [dpdk-web] [PATCH] update quick start page

[Richardson, Bruce]

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Thursday, June 18, 2020 11:00 AM
> To: Richardson, Bruce <bruce.richardson@intel.com>
> Cc: web@dpdk.org
> Subject: Re: [dpdk-web] [PATCH] update quick start page
> 
> 18/06/2020 11:07, Richardson, Bruce:
> > From: Thomas Monjalon <thomas@monjalon.net>
> > > 18/06/2020 10:21, Richardson, Bruce:
> > > > From: Thomas Monjalon
> > > > > --- a/content/doc/quick-start.md
> > > > > +++ b/content/doc/quick-start.md
> > > > > -  make
> > > > > +  meson -Dexamples=all build
> > > >
> > > > Do we really want building all examples to be part of the default
> > > instructions? It will lead to a longer build time?
> > > > I think we should give initial instructions just with meson build,
> > > > and
> > > then afterwards show building examples.
> > >
> > > How do you suggest is the best to compile examples in a second step?
> > > 	meson configure -Dexamples=all ?
> > >
> > >
> >
> > No rather than an additional step, I think showing it as an
> > alternative set of instructions might work well. Something like:
> >
> > """
> > To build the DPDK libraries, drivers and test applications use:
> >
> > meson build
> > ninja -C build
> >
> > To include the examples as part of the build, the -Dexamples flag can
> > be passed to meson, with a comma-separated list of the desired
> > examples, or 'all' to indicate all buildable examples. For example:
> >
> > meson -Dexamples=all build
> > ninja -C build
> > """
> 
> I avoid such long sentence in a quick start guide.
> What about this?
> 
> "
> To include the examples as part of the build, replace the meson command
> with:
> 
> meson -Dexamples=all build
> "
> 
Ack. This is fine to keep it short.

[dpdk-web] [PATCH v2] update quick start page

[Thomas Monjalon]

Use meson instead of make.
Remove -n EAL option.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
v2: add separate build instructions for examples
---
 content/doc/quick-start.md | 19 +++++++------------
 1 file changed, 7 insertions(+), 12 deletions(-)

diff --git a/content/doc/quick-start.md b/content/doc/quick-start.md
index fdffa98..a1c2a6c 100644
--- a/content/doc/quick-start.md
+++ b/content/doc/quick-start.md
@@ -11,17 +11,18 @@ Extract sources
   cd dpdk
 ```
 
-Enable pcap (libpcap headers are required).
+Build libraries, drivers and test applications.
 
 ```
-  make config T=x86_64-native-linuxapp-gcc
-  sed -ri 's,(PMD_PCAP=).*,\1y,' build/.config
+  meson build
+  ninja -C build
 ```
 
-Build libraries and test application (Linux headers may be needed with default config).
+To include the examples as part of the build,
+replace the meson command with:
 
 ```
-  make
+  meson -Dexamples=all build
 ```
 
 Reserve huge pages memory.
@@ -35,7 +36,7 @@ Reserve huge pages memory.
 Run poll-mode driver test (with a cable between ports).
 
 ```
-  build/app/testpmd -c7 -n3 --vdev=net_pcap0,iface=eth0     --vdev=net_pcap1,iface=eth1 --
+  build/app/dpdk-testpmd -c7 --vdev=net_pcap0,iface=eth0 --vdev=net_pcap1,iface=eth1 --
                   -i --nb-cores=2 --nb-ports=2 --total-num-mbufs=2048
 
   testpmd> show port stats all
@@ -69,9 +70,3 @@ Run poll-mode driver test (with a cable between ports).
   TX-packets: 4384729        TX-dropped: 0             TX-total: 4384729
   ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 ```
-
-Some sample applications can be tested after building them.
-
-```
-  make -C examples RTE_SDK=$(pwd) RTE_TARGET=build O=$(pwd)/build/examples
-```
-- 
2.26.2

Re: [dpdk-web] [PATCH v2] update quick start page

[Richardson, Bruce]

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Thursday, June 18, 2020 1:27 PM
> To: web@dpdk.org
> Cc: Richardson, Bruce <bruce.richardson@intel.com>
> Subject: [PATCH v2] update quick start page
> 
> Use meson instead of make.
> Remove -n EAL option.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>


Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Re: [dpdk-web] [PATCH v2] update quick start page

[Thomas Monjalon]

> > Use meson instead of make.
> > Remove -n EAL option.
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied