[PATCH v2 5/5] doc: update doorbell mapping parameter name in mlx5 guide

[Ferruh Yigit]

On 2/25/2022 12:01 AM, Michael Baum wrote:
> 
> On 2/23/2022 11:48 PM, Ferruh Yigit wrote:
>> On 2/23/2022 1:48 PM, Michael Baum wrote:
>>> The "tx_db_nc" devarg forces doorbell register mapping to non-cached
>>> region eliminating the extra write memory barrier. This argument was
>>> used in creating the UAR for Tx and thus affected its performance.
>>>
>>> Recently [1] its use has been extended to all UAR creation in all mlx5
>>> drivers, and now its name is no longer so accurate.
>>>
>>> This patch changes its name to "sq_db_nc" to suit any send queue that
>>> uses it. The old name will still work for backward compatibility.
>>>
>>> [1] commit 5dfa003db53f ("common/mlx5: fix post doorbell barrier")
>>>
>>> Signed-off-by: Michael Baum<michaelba at nvidia.com>
>>> Reviewed-by: Raslan Darawsheh<rasland at nvidia.com>
>>> Acked-by: Viacheslav Ovsiienko<viacheslavo at nvidia.com>
>>> ---
>>>    doc/guides/nics/mlx5.rst                   | 34 ++-----------------
>>>    doc/guides/platform/mlx5.rst               | 39 ++++++++++++++++++++++
>>>    drivers/common/mlx5/linux/mlx5_common_os.c |  2 +-
>>>    drivers/common/mlx5/mlx5_common.c          | 31 ++++++++++++-----
>>>    drivers/common/mlx5/mlx5_common_defs.h     |  8 ++---
>>>    drivers/net/mlx5/linux/mlx5_verbs.c        |  2 +-
>>>    drivers/net/mlx5/mlx5_devx.c               |  2 +-
>>>    7 files changed, 72 insertions(+), 46 deletions(-)
>>
>> Hi Michael,
>>
>> This is not a document patch to update the parameter name, patch actually
>> changes the parameter name in the code and documents it, updating it as:
>> net/mlx5: update doorbell mapping parameter name
> 
> Hi Ferruh,
> 
> Your argument makes sense to me, but most of updates was in MLX5 common library so I think it is better to write:
> common/mlx5: update doorbell mapping parameter name

ack, updated accordingly.