[dpdk-dev] [PATCH 20.11 12/19] doc: remove references to make in Linux gsg guides

Bruce Richardson bruce.richardson at intel.com
Tue Aug 18 16:45:01 CEST 2020


On Fri, Aug 07, 2020 at 01:30:02PM +0100, Ciara Power wrote:
> 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>

Apologies for the multiple emails, but to review this properly I'm
reviewing the text section by section.

/Bruce

> ---
>  doc/guides/linux_gsg/build_dpdk.rst           | 58 -------------------
>  doc/guides/linux_gsg/build_sample_apps.rst    | 16 +----
>  .../linux_gsg/cross_build_dpdk_for_arm64.rst  | 42 --------------
>  doc/guides/linux_gsg/enable_func.rst          |  3 -
>  doc/guides/linux_gsg/intro.rst                |  2 +-
>  doc/guides/linux_gsg/linux_drivers.rst        |  2 -
>  doc/guides/linux_gsg/sys_reqs.rst             |  4 --
>  7 files changed, 4 insertions(+), 123 deletions(-)
> 
<snap>
> diff --git a/doc/guides/linux_gsg/enable_func.rst b/doc/guides/linux_gsg/enable_func.rst
> index b2bda80bb7..40c6f25a6f 100644
> --- a/doc/guides/linux_gsg/enable_func.rst
> +++ b/doc/guides/linux_gsg/enable_func.rst
> @@ -40,9 +40,6 @@ requires that the ``HPET_MMAP`` kernel configuration option be enabled.
>  Enabling HPET in the DPDK
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -By default, HPET support is disabled in the DPDK build configuration files.
This sentence can be kept.

> -To use HPET, the ``CONFIG_RTE_LIBEAL_USE_HPET`` setting should be changed to ``y``, which will enable the HPET settings at compile time.
> -
This should instead refer to the "use_hpet" meson build option. I'm not
sure who, if anyone, still uses hpet for DPDK timers, but that is outside
the scope of this set, so let's just update to match the current situation.

>  For an application to use the ``rte_get_hpet_cycles()`` and ``rte_get_hpet_hz()`` API calls,
>  and optionally to make the HPET the default time source for the rte_timer library,
>  the new ``rte_eal_hpet_init()`` API call should be called at application initialization.

section 8.5 in this chapter discusses kni, and the reference there to the
kmod directory should be replaced by kernel/linux. To cover enabling the
build of it etc., I'd just say it can be enabled in the same way as igb_uio
and give the reference.


More information about the dev mailing list