[PATCH] devlink: remove trigger command from devlink-region.rst

[PATCH] devlink: remove trigger command from devlink-region.rst

[Jacob Keller]

The devlink trigger command does not exist. While rewriting the
documentation for devlink into the reStructuredText format,
documentation for the trigger command was accidentally merged in. This
occurred because the author was also working on a potential extension to
devlink regions which included this trigger command, and accidentally
squashed the documentation incorrectly.

Further review eventually settled on using the previously unused "new"
command instead of creating a new trigger command.

Fix this by removing mention of the trigger command from the
documentation.

Fixes: 0b0f945f5458 ("devlink: add a file documenting devlink regions", 2020-01-10)
Noticed-by: Jiri Pirko <jiri@resnulli.us>
Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
---
 Documentation/networking/devlink/devlink-region.rst | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/Documentation/networking/devlink/devlink-region.rst b/Documentation/networking/devlink/devlink-region.rst
index 1a7683e7acb2..8b46e8591fe0 100644
--- a/Documentation/networking/devlink/devlink-region.rst
+++ b/Documentation/networking/devlink/devlink-region.rst
@@ -40,9 +40,6 @@ example usage
     # Delete a snapshot using:
     $ devlink region del pci/0000:00:05.0/cr-space snapshot 1
 
-    # Trigger (request) a snapshot be taken:
-    $ devlink region trigger pci/0000:00:05.0/cr-space
-
     # Dump a snapshot:
     $ devlink region dump pci/0000:00:05.0/fw-health snapshot 1
     0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30
-- 
2.24.1

Re: [PATCH] devlink: remove trigger command from devlink-region.rst

[Jacob Keller]

Heh, forgot to set subject properly, it should be [net].

Thanks,
Jake

On 3/2/2020 2:21 PM, Jacob Keller wrote:
> The devlink trigger command does not exist. While rewriting the
> documentation for devlink into the reStructuredText format,
> documentation for the trigger command was accidentally merged in. This
> occurred because the author was also working on a potential extension to
> devlink regions which included this trigger command, and accidentally
> squashed the documentation incorrectly.
> 
> Further review eventually settled on using the previously unused "new"
> command instead of creating a new trigger command.
> 
> Fix this by removing mention of the trigger command from the
> documentation.
> 
> Fixes: 0b0f945f5458 ("devlink: add a file documenting devlink regions", 2020-01-10)
> Noticed-by: Jiri Pirko <jiri@resnulli.us>
> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
> ---
>  Documentation/networking/devlink/devlink-region.rst | 3 ---
>  1 file changed, 3 deletions(-)
> 
> diff --git a/Documentation/networking/devlink/devlink-region.rst b/Documentation/networking/devlink/devlink-region.rst
> index 1a7683e7acb2..8b46e8591fe0 100644
> --- a/Documentation/networking/devlink/devlink-region.rst
> +++ b/Documentation/networking/devlink/devlink-region.rst
> @@ -40,9 +40,6 @@ example usage
>      # Delete a snapshot using:
>      $ devlink region del pci/0000:00:05.0/cr-space snapshot 1
>  
> -    # Trigger (request) a snapshot be taken:
> -    $ devlink region trigger pci/0000:00:05.0/cr-space
> -
>      # Dump a snapshot:
>      $ devlink region dump pci/0000:00:05.0/fw-health snapshot 1
>      0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30
> 

Re: [PATCH] devlink: remove trigger command from devlink-region.rst

[Jiri Pirko]

Mon, Mar 02, 2020 at 11:21:19PM CET, jacob.e.keller@intel.com wrote:
>The devlink trigger command does not exist. While rewriting the
>documentation for devlink into the reStructuredText format,
>documentation for the trigger command was accidentally merged in. This
>occurred because the author was also working on a potential extension to
>devlink regions which included this trigger command, and accidentally
>squashed the documentation incorrectly.
>
>Further review eventually settled on using the previously unused "new"
>command instead of creating a new trigger command.
>
>Fix this by removing mention of the trigger command from the
>documentation.
>
>Fixes: 0b0f945f5458 ("devlink: add a file documenting devlink regions", 2020-01-10)
>Noticed-by: Jiri Pirko <jiri@resnulli.us>
>Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>

Reviewed-by: Jiri Pirko <jiri@mellanox.com>

Re: [PATCH] devlink: remove trigger command from devlink-region.rst

[David Miller]

From: Jacob Keller <jacob.e.keller@intel.com>
Date: Mon,  2 Mar 2020 14:21:19 -0800

> The devlink trigger command does not exist. While rewriting the
> documentation for devlink into the reStructuredText format,
> documentation for the trigger command was accidentally merged in. This
> occurred because the author was also working on a potential extension to
> devlink regions which included this trigger command, and accidentally
> squashed the documentation incorrectly.
> 
> Further review eventually settled on using the previously unused "new"
> command instead of creating a new trigger command.
> 
> Fix this by removing mention of the trigger command from the
> documentation.
> 
> Fixes: 0b0f945f5458 ("devlink: add a file documenting devlink regions", 2020-01-10)
> Noticed-by: Jiri Pirko <jiri@resnulli.us>
> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>

Applied, thanks.