Re: [PATCH net-next v2 2/3] netlink: specs: team: avoid mangling multilines doc

[Jakub Kicinski <kuba@kernel.org>]

On Fri, 12 Sep 2025 15:23:00 +0200 Matthieu Baerts (NGI0) wrote:
> By default, strings defined in YAML at the next line are folded:
> newlines are replaced by spaces. Here, the newlines are there for a
> reason, and should be kept in the output.
> 
> This can be fixed by adding the '|' symbol to use the "literal" style.
> This issue was introduced by commit 387724cbf415 ("Documentation:
> netlink: add a YAML spec for team"), but visible in the doc only since
> the parent commit.
> 
> Suggested-by: Donald Hunter <donald.hunter@gmail.com>
> Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
> ---
>  Documentation/netlink/specs/team.yaml | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/netlink/specs/team.yaml b/Documentation/netlink/specs/team.yaml
> index cf02d47d12a458aaa7d45875a0a54af0093d80a8..fae40835386c82e934f205219cc5796e284999f1 100644
> --- a/Documentation/netlink/specs/team.yaml
> +++ b/Documentation/netlink/specs/team.yaml
> @@ -25,7 +25,7 @@ definitions:
>  attribute-sets:
>    -
>      name: team
> -    doc:
> +    doc: |
>        The team nested layout of get/set msg looks like
>            [TEAM_ATTR_LIST_OPTION]
>                [TEAM_ATTR_ITEM_OPTION]
> 

htmldoc is not super happy :(

Documentation/netlink/specs/team.yaml:21: WARNING: Definition list ends without a blank line; unexpected unindent.
Documentation/netlink/specs/team.yaml:21: WARNING: Definition list ends without a blank line; unexpected unindent.

Shooting from the hip -- maybe throwing :: at the end of the first line
will make ReST treat the attrs as a block?
-- 
pw-bot: cr