[dpdk-dev] [PATCH] doc: announce removal of interactive setup script

[Thomas Monjalon]

05/08/2020 18:19, Ferruh Yigit:
> On 8/4/2020 11:26 AM, Thomas Monjalon wrote:
> > Environment configuration is the responsibility of distributions
> > or upper-level frameworks.
> > DPDK focus on documenting the requirements and some recommendations.
> > 
> > Maintaining a good adaptative deployment setup is a project by itself.
> > Anyway this script was interactive, useful only for experimenters.
> > 
> > Signed-off-by: Thomas Monjalon <thomas at monjalon.net>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 4 ++++
> >  1 file changed, 4 insertions(+)
> > 
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index ea4cfa7a48..7ce9fc3e4f 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -151,3 +151,7 @@ Deprecation Notices
> >    Python 2 support will be completely removed in 20.11.
> >    In 20.08, explicit deprecation warnings will be displayed when running
> >    scripts with Python 2.
> > +
> > +* dpdk-setup.sh: This old script relies on deprecated stuff, and especially
> > +  ``make``. Given environments are too much variables for such a simple script,
> > +  it will be removed in DPDK 20.11.
> > 
> 
> Personally I use script as a shortcut to allocate hugemaps, and find that bit
> useful.
> 
> Agree that the environment configuration or deployment script is something else,
> and not sure if this script ever claimed to be one, it is more a user helper
> script I think.
> 
> What do you think remove the build part, which depends to Make build system as
> mentioned above, and keep the rest as a helper script (and perhaps rename to
> highlight the intention), so basically keep only below part:
> 
> ----------------------------------------------------------
>  Step 2: Setup linux environment
> ----------------------------------------------------------
> [45] Insert IGB UIO module
> [46] Insert VFIO module

It does not cover other kernel modules.

> [47] Insert KNI module
> [48] Setup hugepage mappings for non-NUMA systems
> [49] Setup hugepage mappings for NUMA systems

It does not use the standard hugepage directory.

> [50] Display current Ethernet/Baseband/Crypto device settings
> [51] Bind Ethernet/Baseband/Crypto device to IGB UIO module
> [52] Bind Ethernet/Baseband/Crypto device to VFIO module

These are just calling another script in usertools.

> [53] Setup VFIO permissions
> 
> ----------------------------------------------------------
>  Step 4: Other tools
> ----------------------------------------------------------
> [56] List hugepage info from /proc/meminfo
> 
> ----------------------------------------------------------
>  Step 5: Uninstall and system cleanup
> ----------------------------------------------------------
> [57] Unbind devices from IGB UIO or VFIO driver
> [58] Remove IGB UIO module
> [59] Remove VFIO module
> [60] Remove KNI module
> [61] Remove hugepage mappings

This script has bad quality and is very partial.
Are we sure we want to keep above parts?
What about adding separate scripts for VFIO permissions
or hugepage mapping and info?