docs: networking: devlink: capitalise length value

[PATCH] docs: networking: devlink: capitalise length value

Posted by Chris Packham 1 year, 7 months ago

Correct the example to match the help text from the devlink utility.

Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
---
 Documentation/networking/devlink/devlink-region.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/networking/devlink/devlink-region.rst b/Documentation/networking/devlink/devlink-region.rst
index 9232cd7da301..5d0b68f752c0 100644
--- a/Documentation/networking/devlink/devlink-region.rst
+++ b/Documentation/networking/devlink/devlink-region.rst
@@ -49,7 +49,7 @@ example usage
     $ devlink region show [ DEV/REGION ]
     $ devlink region del DEV/REGION snapshot SNAPSHOT_ID
     $ devlink region dump DEV/REGION [ snapshot SNAPSHOT_ID ]
-    $ devlink region read DEV/REGION [ snapshot SNAPSHOT_ID ] address ADDRESS length length
+    $ devlink region read DEV/REGION [ snapshot SNAPSHOT_ID ] address ADDRESS length LENGTH
 
     # Show all of the exposed regions with region sizes:
     $ devlink region show
-- 
2.45.2

Re: [PATCH] docs: networking: devlink: capitalise length value

Posted by Przemek Kitszel 1 year, 7 months ago

On 7/5/24 06:19, Chris Packham wrote:
> Correct the example to match the help text from the devlink utility.
> 
> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
> ---
>   Documentation/networking/devlink/devlink-region.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/networking/devlink/devlink-region.rst b/Documentation/networking/devlink/devlink-region.rst
> index 9232cd7da301..5d0b68f752c0 100644
> --- a/Documentation/networking/devlink/devlink-region.rst
> +++ b/Documentation/networking/devlink/devlink-region.rst
> @@ -49,7 +49,7 @@ example usage
>       $ devlink region show [ DEV/REGION ]
>       $ devlink region del DEV/REGION snapshot SNAPSHOT_ID
>       $ devlink region dump DEV/REGION [ snapshot SNAPSHOT_ID ]
> -    $ devlink region read DEV/REGION [ snapshot SNAPSHOT_ID ] address ADDRESS length length
> +    $ devlink region read DEV/REGION [ snapshot SNAPSHOT_ID ] address ADDRESS length LENGTH
>   
>       # Show all of the exposed regions with region sizes:
>       $ devlink region show

I don't see any other case for such correction in core devlink doc, so:
Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com>