[PATCH 0/3] doc: fix some errors in hns3 guide

[PATCH 0/3] doc: fix some errors in hns3 guide

[Dongdong Liu]

This patchset is to fix some errors in hns3 guide doc.

Dongdong Liu (3):
  doc: fix invalid link in hns3 guide
  doc: fix wrong syntax in hns3 guide
  doc: fix wrong number of spaces in hns3 guide

 doc/guides/nics/hns3.rst | 33 +++++++++++++++++++--------------
 1 file changed, 19 insertions(+), 14 deletions(-)

--
2.22.0

[PATCH 1/3] doc: fix invalid link in hns3 guide

[Dongdong Liu]

The LSC support of Vf driver depends on a patch link in kernel pf driver.
But current the link is invalid, so fixes it.

Add a blank line after the link.

Fixes: 80006b598730 ("doc: add link status event requirements in hns3 guide")
Cc: stable@dpdk.org

Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
---
 doc/guides/nics/hns3.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index 45f9a99a89..a6f3a5eb9e 100644
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -54,7 +54,8 @@ Firmware 1.8.0.0 and later versions support reporting link changes to the PF.
 Therefore, to use the LSC for the PF driver, ensure that the firmware version
 also supports reporting link changes.
 If the VF driver needs to support LSC, special patch must be added:
-`<https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/drivers/net/ethernet/hisilicon/hns3?h=next-20210428&id=18b6e31f8bf4ac7af7b057228f38a5a530378e4e>`_.
+`<https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=18b6e31f8bf4ac7af7b057228f38a5a530378e4e>`_.
+
 Note: The patch has been uploaded to 5.13 of the Linux kernel mainline.
 
 
-- 
2.22.0

[PATCH 2/3] doc: fix wrong syntax in hns3 guide

[Dongdong Liu]

'::' doesn't provide pre-formatted text without an empty line after it,
so fixes it.

Fixes: cdf6a5fbc540 ("doc: add runtime option examples to hns3 guide")
Cc: stable@dpdk.org

Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
---
 doc/guides/nics/hns3.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index a6f3a5eb9e..644d520b64 100644
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -92,6 +92,7 @@ Runtime Configuration
   ``common``.
 
   For example::
+
   -a 0000:7d:00.0,rx_func_hint=simple
 
 - ``tx_func_hint`` (default ``none``)
@@ -112,6 +113,7 @@ Runtime Configuration
   ``common``.
 
   For example::
+
   -a 0000:7d:00.0,tx_func_hint=common
 
 - ``dev_caps_mask`` (default ``0``)
@@ -124,6 +126,7 @@ Runtime Configuration
   Its main purpose is to debug and avoid problems.
 
   For example::
+
   -a 0000:7d:00.0,dev_caps_mask=0xF
 
 - ``mbx_time_limit_ms`` (default ``500``)
-- 
2.22.0

[PATCH 3/3] doc: fix wrong number of spaces in hns3 guide

[Dongdong Liu]

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: 2fc3e696a7f1 ("net/hns3: add runtime config for mailbox limit time")
Cc: stable@dpdk.org

Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
---
 doc/guides/nics/hns3.rst | 27 ++++++++++++++-------------
 1 file changed, 14 insertions(+), 13 deletions(-)

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index 644d520b64..b9f7035300 100644
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -130,19 +130,20 @@ Runtime Configuration
   -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
 
 - ``fdir_vlan_match_mode`` (default ``strict``)
 
-- 
2.22.0

Re: [PATCH 0/3] doc: fix some errors in hns3 guide

[Ferruh Yigit]

On 6/30/2023 8:37 AM, Dongdong Liu wrote:
> This patchset is to fix some errors in hns3 guide doc.
> 
> Dongdong Liu (3):
>   doc: fix invalid link in hns3 guide
>   doc: fix wrong syntax in hns3 guide
>   doc: fix wrong number of spaces in hns3 guide
>

Thanks for the fix.

Series applied to dpdk-next-net/main, thanks.