doc: explain zlib dependency for bnx2x
authorRasesh Mody <rasesh.mody@cavium.com>
Tue, 2 May 2017 23:57:49 +0000 (16:57 -0700)
committerThomas Monjalon <thomas@monjalon.net>
Sun, 7 May 2017 12:45:18 +0000 (14:45 +0200)
Correct CONFIG_RTE_LIBRTE_BNX2X_PMD config file option and add a note
about external zlib dependency for loading the firmware image.

Fixes: ce9b8bb8b998 ("config: disable bnx2x driver")
Cc: stable@dpdk.org
Signed-off-by: Rasesh Mody <rasesh.mody@cavium.com>
doc/guides/nics/bnx2x.rst

index a3a0665..fbfc048 100644 (file)
@@ -96,9 +96,11 @@ Config File Options
 The following options can be modified in the ``.config`` file. Please note that
 enabling debugging options may affect system performance.
 
-- ``CONFIG_RTE_LIBRTE_BNX2X_PMD`` (default **y**)
+- ``CONFIG_RTE_LIBRTE_BNX2X_PMD`` (default **n**)
 
-  Toggle compilation of bnx2x driver.
+  Toggle compilation of bnx2x driver. To use bnx2x PMD set this config parameter
+  to 'y'. Also, in order for firmware binary to load user will need zlib devel
+  package installed.
 
 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG`` (default **n**)