Skip to content

Commit

Permalink
doc: fix number of leading spaces in hns3 guide
Browse files Browse the repository at this point in the history
[ upstream commit 620cd2d5ac5a6d7de750a4827e2840209a1b0cbb ]

The current description of 'mbx_time_limit_ms' has three spaces
at the beginning. Use two spaces to keep the same style with other
places and add a blank line after '::'.

Fixes: 2fc3e69 ("net/hns3: add runtime config for mailbox limit time")

Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
  • Loading branch information
liudongdong3 authored and kevintraynor committed Jul 18, 2023
1 parent 8ecf17c commit 796ccf0
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions doc/guides/nics/hns3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Runtime Config Options

For example::

-a 0000:7d:00.0,rx_func_hint=simple
-a 0000:7d:00.0,rx_func_hint=simple

- ``tx_func_hint`` (default ``none``)

Expand All @@ -103,7 +103,7 @@ Runtime Config Options

For example::

-a 0000:7d:00.0,tx_func_hint=common
-a 0000:7d:00.0,tx_func_hint=common

- ``dev_caps_mask`` (default ``0``)

Expand All @@ -116,22 +116,24 @@ Runtime Config Options

For example::

-a 0000:7d:00.0,dev_caps_mask=0xF
-a 0000:7d:00.0,dev_caps_mask=0xF

- ``mbx_time_limit_ms`` (default ``500``)
Used to define the mailbox time limit by user.
Current, the max waiting time for MBX response is 500ms, but in
some scenarios, it is not enough. Since it depends on the response
of the kernel mode driver, and its response time is related to the
scheduling of the system. In this special scenario, most of the
cores are isolated, and only a few cores are used for system
scheduling. When a large number of services are started, the
scheduling of the system will be very busy, and the reply of the
mbx message will time out, which will cause our PMD initialization
to fail. So provide access to set mailbox time limit for user.

For example::
-a 0000:7d:00.0,mbx_time_limit_ms=600

Used to define the mailbox time limit by user.
Current, the max waiting time for MBX response is 500ms, but in
some scenarios, it is not enough. Since it depends on the response
of the kernel mode driver, and its response time is related to the
scheduling of the system. In this special scenario, most of the
cores are isolated, and only a few cores are used for system
scheduling. When a large number of services are started, the
scheduling of the system will be very busy, and the reply of the
mbx message will time out, which will cause our PMD initialization
to fail. So provide access to set mailbox time limit for user.

For example::

-a 0000:7d:00.0,mbx_time_limit_ms=600

Link status event Pre-conditions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 796ccf0

Please sign in to comment.