[dpdk-dev] [PATCH v2] doc: add link status event pre-conditions

[Andrew Rybchenko]

On 6/30/21 4:56 AM, Min Hu (Connor) wrote:
> From: Chengwen Feng <fengchengwen at huawei.com>
> 
> This patch adds link status event pre-conditions.
> 
> Signed-off-by: Chengwen Feng <fengchengwen at huawei.com>
> Signed-off-by: Min Hu (Connor) <humin29 at huawei.com>
> ---
> v2:
> * not modified, only waiting for 5.13 kernel released.
> ---
>  doc/guides/nics/hns3.rst | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
> index cf72810..c5c55d3 100644
> --- a/doc/guides/nics/hns3.rst
> +++ b/doc/guides/nics/hns3.rst
> @@ -115,6 +115,16 @@ Runtime Config Options
>    For example::
>    -a 0000:7d:00.0,dev_caps_mask=0xF
>  
> +Link status event Pre-conditions
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +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>`_.
> +Note: The patch has been uploaded to 5.13 of the Linux kernel mainline.
> +
>  Driver compilation and testing
>  ------------------------------
>  
> 

I've added extra empty lines before new section and changed
prefix to net/hns3 since doc sounds very misleading for me
here.

net/hns3: add link status event pre-conditions

Add link status event pre-conditions in the driver documentation.

Applied, thanks.

@Thomas I'm not 100% sure about such links in the
documentation. Please, double-check.