[PATCH net-next] tools: ynl: don't append doc of missing type directly to the type

[PATCH net-next] tools: ynl: don't append doc of missing type directly to the type

[Jakub Kicinski]

When using YNL in tests appending the doc string to the type
name makes it harder to check that we got the correct error.
Put the doc under a separate key.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 tools/net/ynl/lib/ynl.py | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/tools/net/ynl/lib/ynl.py b/tools/net/ynl/lib/ynl.py
index 35f82a2c2247..35e666928119 100644
--- a/tools/net/ynl/lib/ynl.py
+++ b/tools/net/ynl/lib/ynl.py
@@ -233,10 +233,9 @@ from .nlspec import SpecFamily
                     miss_type = self.extack['miss-type']
                     if miss_type in attr_space.attrs_by_val:
                         spec = attr_space.attrs_by_val[miss_type]
-                        desc = spec['name']
+                        self.extack['miss-type'] = spec['name']
                         if 'doc' in spec:
-                            desc += f" ({spec['doc']})"
-                        self.extack['miss-type'] = desc
+                            self.extack['miss-type-doc'] = spec['doc']
 
     def _decode_policy(self, raw):
         policy = {}
-- 
2.44.0

Re: [PATCH net-next] tools: ynl: don't append doc of missing type directly to the type

[Donald Hunter]

Jakub Kicinski <kuba@kernel.org> writes:

> When using YNL in tests appending the doc string to the type
> name makes it harder to check that we got the correct error.
> Put the doc under a separate key.
>
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>

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

> ---
>  tools/net/ynl/lib/ynl.py | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/tools/net/ynl/lib/ynl.py b/tools/net/ynl/lib/ynl.py
> index 35f82a2c2247..35e666928119 100644
> --- a/tools/net/ynl/lib/ynl.py
> +++ b/tools/net/ynl/lib/ynl.py
> @@ -233,10 +233,9 @@ from .nlspec import SpecFamily
>                      miss_type = self.extack['miss-type']
>                      if miss_type in attr_space.attrs_by_val:
>                          spec = attr_space.attrs_by_val[miss_type]
> -                        desc = spec['name']
> +                        self.extack['miss-type'] = spec['name']
>                          if 'doc' in spec:
> -                            desc += f" ({spec['doc']})"
> -                        self.extack['miss-type'] = desc
> +                            self.extack['miss-type-doc'] = spec['doc']
>  
>      def _decode_policy(self, raw):
>          policy = {}

Re: [PATCH net-next] tools: ynl: don't append doc of missing type directly to the type

[patchwork-bot+netdevbpf]

Hello:

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

On Thu, 25 Apr 2024 17:31:11 -0700 you wrote:
> When using YNL in tests appending the doc string to the type
> name makes it harder to check that we got the correct error.
> Put the doc under a separate key.
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
>  tools/net/ynl/lib/ynl.py | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)

Here is the summary with links:
  - [net-next] tools: ynl: don't append doc of missing type directly to the type
    https://git.kernel.org/netdev/net-next/c/5c4c0edca68a

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