diff mbox series

ice: document RDMA devlink parameters

Message ID 20230414162614.571861-1-jacob.e.keller@intel.com (mailing list archive)
State Accepted
Commit 1a2bd3bd72e978304cdc0a7385e8048e8242225d
Delegated to: Netdev Maintainers
Headers show
Series ice: document RDMA devlink parameters | expand

Checks

Context Check Description
netdev/series_format warning Single patches do not need cover letters; Target tree name not specified in the subject
netdev/tree_selection success Guessed tree name to be net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 18 this patch: 18
netdev/cc_maintainers fail 7 maintainers not CCed: pabeni@redhat.com jiri@resnulli.us corbet@lwn.net linux-doc@vger.kernel.org kuba@kernel.org edumazet@google.com davem@davemloft.net
netdev/build_clang success Errors and warnings before: 18 this patch: 18
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 18 this patch: 18
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 21 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Jacob Keller April 14, 2023, 4:26 p.m. UTC
Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
devlink param") added support for the enable_roce and enable_iwarp
parameters in the ice driver. It didn't document these parameters in the
ice devlink documentation file. Add this documentation, including a note
about the mutual exclusion between the two modes.

Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
---
 Documentation/networking/devlink/ice.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Jakub Kicinski April 15, 2023, 1:18 a.m. UTC | #1
On Fri, 14 Apr 2023 09:26:14 -0700 Jacob Keller wrote:
> Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
> devlink param") added support for the enable_roce and enable_iwarp
> parameters in the ice driver. It didn't document these parameters in the
> ice devlink documentation file. Add this documentation, including a note
> about the mutual exclusion between the two modes.

Thanks! We do need an ack from Tony if we're supposed to take 
this directly, tho. FWIW in case Tony takes it in - it should 
go towards net.
Leon Romanovsky April 16, 2023, 10:02 a.m. UTC | #2
On Fri, Apr 14, 2023 at 09:26:14AM -0700, Jacob Keller wrote:
> Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
> devlink param") added support for the enable_roce and enable_iwarp
> parameters in the ice driver. It didn't document these parameters in the
> ice devlink documentation file. Add this documentation, including a note
> about the mutual exclusion between the two modes.
> 
> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
> ---
>  Documentation/networking/devlink/ice.rst | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 

Thanks,
Reviewed-by: Leon Romanovsky <leonro@nvidia.com>
Tony Nguyen April 17, 2023, 4:24 p.m. UTC | #3
On 4/14/2023 6:18 PM, Jakub Kicinski wrote:
> On Fri, 14 Apr 2023 09:26:14 -0700 Jacob Keller wrote:
>> Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
>> devlink param") added support for the enable_roce and enable_iwarp
>> parameters in the ice driver. It didn't document these parameters in the
>> ice devlink documentation file. Add this documentation, including a note
>> about the mutual exclusion between the two modes.
> 
> Thanks! We do need an ack from Tony if we're supposed to take
> this directly, tho. FWIW in case Tony takes it in - it should
> go towards net.

Since this is documentation only, I feel like it doesn't need to go 
through IWL, unless you'd like it to. I'm ok either way. I'll add my ack 
on to the patch in case you want to take it directly.

Thanks,
Tony
Tony Nguyen April 17, 2023, 4:25 p.m. UTC | #4
On 4/14/2023 9:26 AM, Jacob Keller wrote:
> Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
> devlink param") added support for the enable_roce and enable_iwarp
> parameters in the ice driver. It didn't document these parameters in the
> ice devlink documentation file. Add this documentation, including a note
> about the mutual exclusion between the two modes.
> 
> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>

Acked-by: Tony Nguyen <anthony.l.nguyen@intel.com>

> ---
>   Documentation/networking/devlink/ice.rst | 15 +++++++++++++++
>   1 file changed, 15 insertions(+)
> 
> diff --git a/Documentation/networking/devlink/ice.rst b/Documentation/networking/devlink/ice.rst
> index 10f282c2117c..0e39a0caba55 100644
> --- a/Documentation/networking/devlink/ice.rst
> +++ b/Documentation/networking/devlink/ice.rst
> @@ -7,6 +7,21 @@ ice devlink support
>   This document describes the devlink features implemented by the ``ice``
>   device driver.
>   
> +Parameters
> +==========
> +
> +.. list-table:: Generic parameters implemented
> +
> +   * - Name
> +     - Mode
> +     - Notes
> +   * - ``enable_roce``
> +     - runtime
> +     - mutually exclusive with ``enable_iwarp``
> +   * - ``enable_iwarp``
> +     - runtime
> +     - mutually exclusive with ``enable_roce``
> +
>   Info versions
>   =============
>
patchwork-bot+netdevbpf@kernel.org April 18, 2023, 2 a.m. UTC | #5
Hello:

This patch was applied to netdev/net.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Fri, 14 Apr 2023 09:26:14 -0700 you wrote:
> Commit e523af4ee560 ("net/ice: Add support for enable_iwarp and enable_roce
> devlink param") added support for the enable_roce and enable_iwarp
> parameters in the ice driver. It didn't document these parameters in the
> ice devlink documentation file. Add this documentation, including a note
> about the mutual exclusion between the two modes.
> 
> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
> 
> [...]

Here is the summary with links:
  - ice: document RDMA devlink parameters
    https://git.kernel.org/netdev/net/c/1a2bd3bd72e9

You are awesome, thank you!
diff mbox series

Patch

diff --git a/Documentation/networking/devlink/ice.rst b/Documentation/networking/devlink/ice.rst
index 10f282c2117c..0e39a0caba55 100644
--- a/Documentation/networking/devlink/ice.rst
+++ b/Documentation/networking/devlink/ice.rst
@@ -7,6 +7,21 @@  ice devlink support
 This document describes the devlink features implemented by the ``ice``
 device driver.
 
+Parameters
+==========
+
+.. list-table:: Generic parameters implemented
+
+   * - Name
+     - Mode
+     - Notes
+   * - ``enable_roce``
+     - runtime
+     - mutually exclusive with ``enable_iwarp``
+   * - ``enable_iwarp``
+     - runtime
+     - mutually exclusive with ``enable_roce``
+
 Info versions
 =============