[dpdk-dev] [PATCH v5 03/20] doc: remove references to make from Linux guide

[Thomas Monjalon]

01/10/2020 10:36, Power, Ciara:
>From: Thomas Monjalon <thomas at monjalon.net>
> >
> >Hi,
> >
> >Below are some comments. If you agree, I will do the changes myself while
> >pushing to the main branch.
> >
> >
> >21/09/2020 15:59, Ciara Power:
> >> Make is no longer supported for compiling DPDK, references are now
> >> removed in the documentation.
> >>
> >> Signed-off-by: Ciara Power <ciara.power at intel.com>
> >> Reviewed-by: Bruce Richardson <bruce.richardson at intel.com>
> >> ---
> >>  doc/guides/linux_gsg/build_dpdk.rst        | 16 +++++++++++-----
> >>  doc/guides/linux_gsg/build_sample_apps.rst | 18 +++---------------
> >>  doc/guides/linux_gsg/enable_func.rst       | 13 +++++--------
> >>  doc/guides/linux_gsg/linux_drivers.rst     | 18 +++++++++++-------
> >>  doc/guides/linux_gsg/sys_reqs.rst          |  6 +-----
> >>  5 files changed, 31 insertions(+), 40 deletions(-)
> >>
> >> diff --git a/doc/guides/linux_gsg/build_dpdk.rst
> >> b/doc/guides/linux_gsg/build_dpdk.rst
> >> index a895e1b0f4..85d04520bf 100644
> >> --- a/doc/guides/linux_gsg/build_dpdk.rst
> >> +++ b/doc/guides/linux_gsg/build_dpdk.rst
> >> @@ -76,6 +76,8 @@ and the last step causing the dynamic loader `ld.so`
> >to update its cache to take
> >>     distributions, `/usr/local/lib` and `/usr/local/lib64` should be added
> >>     to a file in `/etc/ld.so.conf.d/` before running `ldconfig`.
> >>
> >> +.. _adjusting_build_options:
> >> +
> >
> >extra blank line
> 
> Blank line here, and below, were added based on the contributing guide - " Add 2 blank lines before each section header."
> Okay to remove if that has changed.

Yes, the recommendation is 2 blank lines to separate a paragraph
from the next title. But here it is an anchor for the next title,
so it should be grouped together.

> >>  Adjusting Build Options
> >>  ~~~~~~~~~~~~~~~~~~~~~~~
> >> @@ -112,6 +114,9 @@ dependencies are met on the current system are
> >built.
> >>  When `-Dexamples=all` is set as a meson option, meson will check each
> >> example application to see if it can be built,  and add all which can be built
> >to the list of tasks in the ninja build configuration file.
> >>
> >> +.. _building_app_using_installed_dpdk:
> >> +
> >> +
> >
> >extra blank line
> >
> >>  Building Applications Using Installed DPDK
> >> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> >>
> >> @@ -135,11 +140,12 @@ and the sources for that build are stored in
> >``$(SRCS-y)``.
> >>
> >>  .. note::
> >>
> >> -   Unlike with the older make build system, the meson system is not
> >> -   designed to be used directly from a build directory. Instead it is
> >> -   recommended that it be installed either system-wide or to a known
> >> -   location in the user's home directory. The install location can be set
> >> -   using the `--prefix` meson option (default: `/usr/local`).
> >> +   Unlike with the make build system present used in older DPDK releases,
> >> +   the meson system is not designed to be used directly from a build
> >> +   directory. Instead it is recommended that it be installed either
> >> +   system-wide or to a known location in the user's home directory.
> >> +   The install location can be set using the `--prefix` meson option
> >> +   (default: `/usr/local`).
> >
> >I prefer the first version.
> >The words "system present used" look weird.
> >Anyway, if any reword is needed, better to change only the impacted line and
> >keep the rest of the line wrapping untouched.
> >
> I think this was a typo on the first line, should have been either "present" or "used", not both.

OK will fix.

[...]
> >> --- a/doc/guides/linux_gsg/enable_func.rst
> >> +++ b/doc/guides/linux_gsg/enable_func.rst
> >[...]
> >> @@ -128,13 +130,8 @@ Loading the DPDK KNI Kernel Module
> >>  ----------------------------------
> >>
> >>  To run the DPDK Kernel NIC Interface (KNI) sample application, an extra
> >kernel module (the kni module) must be loaded into the running kernel.
> >> -The module is found in the kmod sub-directory of the DPDK target
> >directory.
> >> -Similar to the loading of the ``igb_uio`` module, this module should
> >> be loaded using the insmod command as shown below -(assuming that the
> >current directory is the DPDK target directory):
> >> -
> >> -.. code-block:: console
> >> -
> >> -   insmod kmod/rte_kni.ko
> >> +The module is found in the kernel/linux sub-directory of the DPDK build
> >directory.
> >> +This can be enabled in the same way as the ``igb_uio`` module, please see
> >:ref:`load_uio` for details.
> >
> >The only relevant info in "load_uio" chapter is to use insmod.
> >I think it is better to keep some lines above:
> >
> >It should be loaded using the insmod command::
> >
> >   insmod kmod/rte_kni.ko
> 
> I think this should be the updated path:
> " <build_dir>/kernel/linux/kni/rte_kni.ko"

Yes of course.
Thanks