diff mbox series

[net,1/2] docs: net: tweak devlink health documentation

Message ID 20210313003026.1685290-1-kuba@kernel.org
State New
Headers show
Series [net,1/2] docs: net: tweak devlink health documentation | expand

Commit Message

Jakub Kicinski March 13, 2021, 12:30 a.m. UTC 
Minor tweaks and improvement of wording about the diagnose callback.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/devlink/devlink-health.rst | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

Comments

patchwork-bot+netdevbpf@kernel.org March 14, 2021, 2:20 a.m. UTC | #1 
Hello:

This series was applied to netdev/net-next.git (refs/heads/master):

On Fri, 12 Mar 2021 16:30:25 -0800 you wrote:
> Minor tweaks and improvement of wording about the diagnose callback.

> 

> Signed-off-by: Jakub Kicinski <kuba@kernel.org>

> ---

>  Documentation/networking/devlink/devlink-health.rst | 13 +++++++------

>  1 file changed, 7 insertions(+), 6 deletions(-)


Here is the summary with links:
  - [net,1/2] docs: net: tweak devlink health documentation
    https://git.kernel.org/netdev/net-next/c/3cc9b29ac0e1
  - [net,2/2] docs: net: add missing devlink health cmd - trigger
    https://git.kernel.org/netdev/net-next/c/6f1629093399

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
diff mbox series

Patch

diff --git a/Documentation/networking/devlink/devlink-health.rst b/Documentation/networking/devlink/devlink-health.rst
index 0c99b11f05f9..d52c9a605188 100644
--- a/Documentation/networking/devlink/devlink-health.rst
+++ b/Documentation/networking/devlink/devlink-health.rst
@@ -24,7 +24,7 @@  attributes of the health reporting and recovery procedures.
 
 The ``devlink`` health reporter:
 Device driver creates a "health reporter" per each error/health type.
-Error/Health type can be a known/generic (eg pci error, fw error, rx/tx error)
+Error/Health type can be a known/generic (e.g. PCI error, fw error, rx/tx error)
 or unknown (driver specific).
 For each registered health reporter a driver can issue error/health reports
 asynchronously. All health reports handling is done by ``devlink``.
@@ -48,6 +48,7 @@  Actions
   * Object dump is being taken and saved at the reporter instance (as long as
     there is no other dump which is already stored)
   * Auto recovery attempt is being done. Depends on:
+
     - Auto-recovery configuration
     - Grace period vs. time passed since last recover
 
@@ -72,14 +73,14 @@  User can access/change each reporter's parameters and driver specific callbacks
    * - ``DEVLINK_CMD_HEALTH_REPORTER_SET``
      - Allows reporter-related configuration setting.
    * - ``DEVLINK_CMD_HEALTH_REPORTER_RECOVER``
-     - Triggers a reporter's recovery procedure.
+     - Triggers reporter's recovery procedure.
    * - ``DEVLINK_CMD_HEALTH_REPORTER_DIAGNOSE``
-     - Retrieves diagnostics data from a reporter on a device.
+     - Retrieves current device state related to the reporter.
    * - ``DEVLINK_CMD_HEALTH_REPORTER_DUMP_GET``
      - Retrieves the last stored dump. Devlink health
-       saves a single dump. If an dump is not already stored by the devlink
+       saves a single dump. If an dump is not already stored by devlink
        for this reporter, devlink generates a new dump.
-       dump output is defined by the reporter.
+       Dump output is defined by the reporter.
    * - ``DEVLINK_CMD_HEALTH_REPORTER_DUMP_CLEAR``
      - Clears the last saved dump file for the specified reporter.
 
@@ -93,7 +94,7 @@  User can access/change each reporter's parameters and driver specific callbacks
                                           +--------------------------+
                                                        |request for ops
                                                        |(diagnose,
-     mlx5_core                             devlink     |recover,
+      driver                               devlink     |recover,
                                                        |dump)
     +--------+                            +--------------------------+
     |        |                            |    reporter|             |