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

Richardson, Bruce bruce.richardson at intel.com
Thu Jun 18 12:17:26 CEST 2020



> -----Original Message-----
> From: Thomas Monjalon <thomas at monjalon.net>
> Sent: Thursday, June 18, 2020 11:00 AM
> To: Richardson, Bruce <bruce.richardson at intel.com>
> Cc: web at dpdk.org
> Subject: Re: [dpdk-web] [PATCH] update quick start page
> 
> 18/06/2020 11:07, Richardson, Bruce:
> > From: Thomas Monjalon <thomas at 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.


More information about the web mailing list