[02/36] doc: avoid references to removed config variables in net/sfc

Message ID 1602596753-32282-3-git-send-email-arybchenko@solarflare.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series net/sfc: add EF100 support |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Andrew Rybchenko Oct. 13, 2020, 1:45 p.m. UTC
  CONFIG_* variables were used by make-based build system which is
removed.

Fixes: 3cc6ecfdfe85 ("build: remove makefiles")

Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com>
---
 doc/guides/nics/sfc_efx.rst | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)
  

Comments

Ferruh Yigit Oct. 14, 2020, 10:40 a.m. UTC | #1
On 10/13/2020 2:45 PM, Andrew Rybchenko wrote:
> CONFIG_* variables were used by make-based build system which is
> removed.
> 
> Fixes: 3cc6ecfdfe85 ("build: remove makefiles")
> 
> Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com>
> ---
>   doc/guides/nics/sfc_efx.rst | 14 ++++++--------
>   1 file changed, 6 insertions(+), 8 deletions(-)
> 
> diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst
> index 812c1e7951..84b9b56ddb 100644
> --- a/doc/guides/nics/sfc_efx.rst
> +++ b/doc/guides/nics/sfc_efx.rst
> @@ -273,17 +273,15 @@ Pre-Installation Configuration
>   ------------------------------
>   
>   
> -Config File Options
> -~~~~~~~~~~~~~~~~~~~
> +Build Options
> +~~~~~~~~~~~~~
>   
> -The following options can be modified in the ``.config`` file.
> -Please note that enabling debugging options may affect system performance.
> -
> -- ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
> +The following build-time options may be enabled on build time using
> +``-Dc_args=`` meson argument (e.g.  ``-Dc_args=-DRTE_LIBRTE_SFC_EFX_DEBUG``).
>   
> -  Enable compilation of Solarflare libefx-based poll-mode driver.
> +Please note that enabling debugging options may affect system performance.
>   
> -- ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
> +- ``RTE_LIBRTE_SFC_EFX_DEBUG`` (undefined by default)
>   
>     Enable compilation of the extra run-time consistency checks.
>   
> 

This will conflict with Ciara's Make removal patch:
https://patches.dpdk.org/patch/80120/

cc'ed Ciara & Thomas to be aware of it.
  

Patch

diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst
index 812c1e7951..84b9b56ddb 100644
--- a/doc/guides/nics/sfc_efx.rst
+++ b/doc/guides/nics/sfc_efx.rst
@@ -273,17 +273,15 @@  Pre-Installation Configuration
 ------------------------------
 
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
+Build Options
+~~~~~~~~~~~~~
 
-The following options can be modified in the ``.config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
+The following build-time options may be enabled on build time using
+``-Dc_args=`` meson argument (e.g.  ``-Dc_args=-DRTE_LIBRTE_SFC_EFX_DEBUG``).
 
-  Enable compilation of Solarflare libefx-based poll-mode driver.
+Please note that enabling debugging options may affect system performance.
 
-- ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
+- ``RTE_LIBRTE_SFC_EFX_DEBUG`` (undefined by default)
 
   Enable compilation of the extra run-time consistency checks.