From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wm1-f52.google.com (mail-wm1-f52.google.com [209.85.128.52]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 125A03126BC for ; Thu, 11 Sep 2025 11:20:53 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.52 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757589655; cv=none; b=QO1qwQyFY1N9eclK7UnOOOMMzsHIzv0pMQ5vek3ADQsc5VSdBMwJVnJiysSTmfAoTOeeAtqba/k9zbkwFKSIkFIvgBXKMGC+OOijl9SWD/8RDj6Fln61TkrguCT3xFjgu6WkZC9orn74ViMRMCm+aMtLQxa/VX1Susnj00hYuWM= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757589655; c=relaxed/simple; bh=H8yk+xrqMoi1BmiRtNvzwsuYwehWP27jlscfOOwW9g0=; h=From:To:Cc:Subject:In-Reply-To:Date:Message-ID:References: MIME-Version:Content-Type; b=CcS8qDitGRKpZKsZA7tD7MuHw0ptRjLIH+3ZgQwvQh3b3l6vJX3vx5jiDi8rF1K+yzvlYMM4HZc+QfCV7sjVYMgub1lGzKMFmaeP8S0E/KU8bZHq7c21yBVos27vsXnOKorfKlqQocn2SHx8Lig3aQKItZEPYl3sTzHep8CgqkA= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=BY5usAHu; arc=none smtp.client-ip=209.85.128.52 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="BY5usAHu" Received: by mail-wm1-f52.google.com with SMTP id 5b1f17b1804b1-45cb6428c46so7572895e9.1 for ; Thu, 11 Sep 2025 04:20:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1757589652; x=1758194452; darn=vger.kernel.org; h=mime-version:user-agent:references:message-id:date:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=h2HQS+cQinE0HErUF+RK2/CMrXAUaYTUSDi0hoQyZeM=; b=BY5usAHuL0pcxURLrYzKIpLS9bohcNiHdFZGsM/RAQJaGFnRX2PgBX/kQRB5VeygMT 2/EKGTXw6usiTZnn8ISx8WWdmHJDCXZKnia4D9r+l8uVdSqH0AgtQ3wgFBbpB0zBUCND j1D5sUOWavyIDoYKtWUEPeXT8BHs9A0UjnH1XSdlouQxV1JM6+b4BRjv+4XGWE2RWf6h Yn7DyUgbZe7ypeUI3lna7zBODaeZW5gBi6qr+YoJ+n5vPnBGNS0M28PHzzTVRjC+CbHg pm2S/cL/3LmOy+4tSpPiGtzCEWgZacwHeEJt+kzooMj6SV4eWbQokBeVI0ZIrHFSUYfs hgiA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1757589652; x=1758194452; h=mime-version:user-agent:references:message-id:date:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=h2HQS+cQinE0HErUF+RK2/CMrXAUaYTUSDi0hoQyZeM=; b=cA9DFpn/SNGIOcL5fmqhXhARd9W8wUOnRMaBYcww9Kj2PJ2X7TfHA6gnLk+F91auDq XQKUQUjT8lkMhDgxoEr/Agpju9nhsRJZnjzuYlsZlDNLcKX+Ghx+ScPMq71607eXgIUQ DmtgPxtHnarW53gWGIB5ZFgL55ohpnyWiBRgvpE1XkBoQAQ4Bqi6WCei7WVvSO4RYZZP lkDFTEhZm90HtXVSFxOhH5tSFfH7p7/urJqbCN016vl9v2BNoToj6xJsiCIcbhOSmyLM ltUJtEkqgNG0efGdoJ7kz0yUCnxdjSqQTviEQLkXdRKk7gDwfgZC9fFQttLWP4RxbdUa JkaQ== X-Forwarded-Encrypted: i=1; AJvYcCWM7VbMszGVVB72yaMz9gNvTRojJXoUof+AA8GXemDHvv965hafz7hKCUUwascYZf5eedzX+iI=@vger.kernel.org X-Gm-Message-State: AOJu0Yzn86qxiOsjQSa59NeYu6ng0nGToFjhnvjLbWwEeDRwDEHdgWBs vL0PIELDZwkyeHXCbioq5f/DCz5JYM3uAzmyzfzKG8z6g05ZlJk0FB+3 X-Gm-Gg: ASbGncsYENV9qGrOnLqVqGUja7t8h0bK25CjBlQ/qxgmqMrVNnBU6LcwUFnzRMwNn+Y eN5qiczWrbczp5d+pSqZuQEHYYG4k1Mub8d8+Z2EqqgDeoP+d2keoCMiCQax7undtWBdafY+a29 u/wtH0CG1keC7nVCCb7+Wet4kBFDUXUlvOdX+mp2VsrxP1IASvMYb9zJIZCwPhaZyFBIy734cED xNKrrKsbMCIjCztxWWfXX3njB4ap2jqS9bD6g/selO06m38ZRc4q0TEfZRFLxUqImWtr4ji3brT twxA6k259zwpzQSZZxlvs9gPONqwl//nRyIu682vxxjCp89TO21sjtywzwV8KXLZzxgb2JpI4gj zevLTUc4jHlO0Xlmqlzv8z65PXwjSFqEs/HZl9/I= X-Google-Smtp-Source: AGHT+IGo+F4NUZA5jrtFJZ3gols7D7bXthNGq85BXY2ZGDeIz6G8pf+puXsiQ9wTfeZ6/fjO6sDA+Q== X-Received: by 2002:a5d:64e7:0:b0:3da:e7d7:f1ec with SMTP id ffacd0b85a97d-3e646257889mr15832414f8f.32.1757589651961; Thu, 11 Sep 2025 04:20:51 -0700 (PDT) Received: from imac ([2a02:8010:60a0:0:18f9:fa9:c12a:ac60]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3e760786ceasm2152003f8f.16.2025.09.11.04.20.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 Sep 2025 04:20:51 -0700 (PDT) From: Donald Hunter To: "Matthieu Baerts (NGI0)" Cc: Jonathan Corbet , Jakub Kicinski , "David S. Miller" , Eric Dumazet , Paolo Abeni , Simon Horman , linux-doc@vger.kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH net-next] tools: ynl: rst: display attribute-set doc In-Reply-To: <20250910-net-next-ynl-attr-doc-rst-v1-1-0bbc77816174@kernel.org> Date: Thu, 11 Sep 2025 11:44:55 +0100 Message-ID: References: <20250910-net-next-ynl-attr-doc-rst-v1-1-0bbc77816174@kernel.org> User-Agent: Gnus/5.13 (Gnus v5.13) Precedence: bulk X-Mailing-List: netdev@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain "Matthieu Baerts (NGI0)" writes: > Some attribute-set have a documentation (doc:), but it was not displayed > in the RST / HTML version. Such field can be found in ethtool, netdev, > tcp_metrics and team YAML files. > > Only the 'name' and 'attributes' fields from an 'attribute-set' section > were parsed. Now the content of the 'doc' field, if available, is added > as a new paragraph before listing each attribute. This is similar to > what is done when parsing the 'operations'. This fix looks good, but exposes the same issue with the team attribute-set in team.yaml. The following patch is sufficient to generate output that sphinx doesn't mangle: diff --git a/Documentation/netlink/specs/team.yaml b/Documentation/netlink/specs/team.yaml index cf02d47d12a4..fae40835386c 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] > Signed-off-by: Matthieu Baerts (NGI0) > --- > Note: this patch can be applied without conflicts on top of net-next and > docs-next. To be honest, it is not clear to me who is responsible for > applying it :) > --- > tools/net/ynl/pyynl/lib/doc_generator.py | 4 ++++ > 1 file changed, 4 insertions(+) > > diff --git a/tools/net/ynl/pyynl/lib/doc_generator.py b/tools/net/ynl/pyynl/lib/doc_generator.py > index 403abf1a2edaac6936d0e9db0623cd3e07aaad8e..3a16b8eb01ca0cf61a5983d3bd6a866e04c75844 100644 > --- a/tools/net/ynl/pyynl/lib/doc_generator.py > +++ b/tools/net/ynl/pyynl/lib/doc_generator.py > @@ -289,6 +289,10 @@ class YnlDocGenerator: > for entry in entries: > lines.append(self.fmt.rst_section(namespace, 'attribute-set', > entry["name"])) > + > + if "doc" in entry: > + lines.append(self.fmt.rst_paragraph(entry["doc"], 0) + "\n") > + > for attr in entry["attributes"]: > if LINE_STR in attr: > lines.append(self.fmt.rst_lineno(attr[LINE_STR])) > > --- > base-commit: deb105f49879dd50d595f7f55207d6e74dec34e6 > change-id: 20250910-net-next-ynl-attr-doc-rst-b61532634245 > > Best regards,