[v1,2/2] doc/failsafe: fix incorrect statement regarding number of sub-device
diff mbox series

Message ID 6a49dddd485cb1a133e9f100fba68341d575254e.1582330416.git.grive@u256.net
State Accepted
Delegated to: Ferruh Yigit
Headers show
  • failsafe: improve documentation
Related show


Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Gaetan Rivet Feb. 22, 2020, 12:14 a.m. UTC
Supporting more than 2 sub-device is a remnant from earlier fail-safe
design, that was never actually published.

Fixes: a46f8d584eb8 ("net/failsafe: add fail-safe PMD")
Cc: stable@dpdk.org

Signed-off-by: Gaetan Rivet <grive@u256.net>
 doc/guides/nics/fail_safe.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff mbox series

diff --git a/doc/guides/nics/fail_safe.rst b/doc/guides/nics/fail_safe.rst
index 3ce2f8bee..b4a92f663 100644
--- a/doc/guides/nics/fail_safe.rst
+++ b/doc/guides/nics/fail_safe.rst
@@ -49,7 +49,7 @@  The Fail-safe PMD can be used like most other DPDK virtual devices, by passing a
 ``--vdev`` parameter to the EAL when starting the application. The device name
 must start with the *net_failsafe* prefix, followed by numbers or letters. This
 name must be unique for each device. Each fail-safe instance must have at least one
-sub-device, up to ``RTE_MAX_ETHPORTS-1``.
+sub-device, and at most two.
 A sub-device can be any DPDK device, including possibly another fail-safe device.