[dpdk-dev] [PATCH v6 12/14] doc: remove references to make from contributing guide

Thomas Monjalon thomas at monjalon.net
Sun Oct 11 22:52:08 CEST 2020


09/10/2020 12:21, Ciara Power:
> -   As in the linux kernel, the ``CONFIG_`` prefix is not used in C code.
> -   This is only needed in Makefiles or shell scripts.
> +* Use build definition macros and conditions in the Meson build file. This is done when the differences
> +  are more significant. In this case, the code is split into two separate files that are architecture
> +  or environment specific. This should only apply inside the EAL library.

When writing new sentences, it's better splitting lines after a punctuation,
preferably the end of a sentence.


>  Per Architecture Sources
>  ~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -The following config options can be used:
> +The following macro options can be used:
>  
> -* ``CONFIG_RTE_ARCH`` is a string that contains the name of the architecture.
> -* ``CONFIG_RTE_ARCH_I686``, ``CONFIG_RTE_ARCH_X86_64``, ``CONFIG_RTE_ARCH_X86_64_32`` or ``CONFIG_RTE_ARCH_PPC_64`` are defined only if we are building for those architectures.
> +* ``RTE_ARCH`` is a string that contains the name of the architecture.
> +* ``RTE_ARCH_I686``, ``RTE_ARCH_X86_64``, ``RTE_ARCH_X86_64_32`` or ``RTE_ARCH_PPC_64`` are defined only if we are building for those architectures.

This is out of date. Arm is notably missing.

>  Per Execution Environment Sources
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -The following config options can be used:
> +The following macro options can be used:
>  
> -* ``CONFIG_RTE_EXEC_ENV`` is a string that contains the name of the executive environment.
> -* ``CONFIG_RTE_EXEC_ENV_FREEBSD`` or ``CONFIG_RTE_EXEC_ENV_LINUX`` are defined only if we are building for this execution environment.
> +* ``RTE_EXEC_ENV`` is a string that contains the name of the executive environment.
> +* ``RTE_EXEC_ENV_FREEBSD`` or ``RTE_EXEC_ENV_LINUX`` are defined only if we are building for this execution environment.

This is out of date. Windows is missing.

[...]
> -* Generate all the documentation targets::
> +To enable doc building::
>  
> -     make doc
> +   meson configure -Denable_docs=true

No need of this option.
"ninja -C build doc" works even without it.





More information about the dev mailing list