diff mbox series

[net-next,1/3] tools: ynl: correct typo and docstring

Message ID 800f2681d56b5195c8b22173a3b83bbac021af92.1705950652.git.alessandromarcolini99@gmail.com (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series tools: ynl: Add sub-message and multi-attr encoding support | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
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: 8 this patch: 8
netdev/build_tools success Errors and warnings before: 2 this patch: 0
netdev/cc_maintainers success CCed 0 of 0 maintainers
netdev/build_clang success Errors and warnings before: 8 this patch: 8
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: 8 this patch: 8
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 20 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Alessandro Marcolini Jan. 22, 2024, 7:19 p.m. UTC 
Correct typo in SpecAttr docstring. Changed SpecSubMessageFormat
docstring.

Signed-off-by: Alessandro Marcolini <alessandromarcolini99@gmail.com>
---
 tools/net/ynl/lib/nlspec.py | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

Comments

Donald Hunter Jan. 23, 2024, 4:28 p.m. UTC | #1 
Alessandro Marcolini <alessandromarcolini99@gmail.com> writes:

> Correct typo in SpecAttr docstring. Changed SpecSubMessageFormat
> docstring.

These docstring updates lgtm.

Reviewed-by: Donald Hunter <donald.hunter@gmail.com>

> Signed-off-by: Alessandro Marcolini <alessandromarcolini99@gmail.com>
> ---
>  tools/net/ynl/lib/nlspec.py | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)
>
> diff --git a/tools/net/ynl/lib/nlspec.py b/tools/net/ynl/lib/nlspec.py
> index 44f13e383e8a..f8feae363970 100644
> --- a/tools/net/ynl/lib/nlspec.py
> +++ b/tools/net/ynl/lib/nlspec.py
> @@ -144,7 +144,7 @@ class SpecEnumSet(SpecElement):
>  
>  
>  class SpecAttr(SpecElement):
> -    """ Single Netlink atttribute type
> +    """ Single Netlink attribute type
>  
>      Represents a single attribute type within an attr space.
>  
> @@ -306,10 +306,9 @@ class SpecSubMessage(SpecElement):
>  
>  
>  class SpecSubMessageFormat(SpecElement):
> -    """ Netlink sub-message definition
> +    """ Netlink sub-message format definition
>  
> -    Represents a set of sub-message formats for polymorphic nlattrs
> -    that contain type-specific sub messages.
> +    Represents a single format for a sub-message.
>  
>      Attributes:
>          value         attribute value to match against type selector
diff mbox series

Patch

diff --git a/tools/net/ynl/lib/nlspec.py b/tools/net/ynl/lib/nlspec.py
index 44f13e383e8a..f8feae363970 100644
--- a/tools/net/ynl/lib/nlspec.py
+++ b/tools/net/ynl/lib/nlspec.py
@@ -144,7 +144,7 @@  class SpecEnumSet(SpecElement):
 
 
 class SpecAttr(SpecElement):
-    """ Single Netlink atttribute type
+    """ Single Netlink attribute type
 
     Represents a single attribute type within an attr space.
 
@@ -306,10 +306,9 @@  class SpecSubMessage(SpecElement):
 
 
 class SpecSubMessageFormat(SpecElement):
-    """ Netlink sub-message definition
+    """ Netlink sub-message format definition
 
-    Represents a set of sub-message formats for polymorphic nlattrs
-    that contain type-specific sub messages.
+    Represents a single format for a sub-message.
 
     Attributes:
         value         attribute value to match against type selector