From: Donald Hunter <donald.hunter@gmail.com>
To: Jakub Kicinski <kuba@kernel.org>
Cc: netdev@vger.kernel.org, "David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Paolo Abeni <pabeni@redhat.com>,
Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org,
Jacob Keller <jacob.e.keller@intel.com>,
donald.hunter@redhat.com, Breno Leitao <leitao@debian.org>
Subject: Re: [PATCH net-next v2 01/11] tools/net/ynl-gen-rst: Use bullet lists for attribute-set entries
Date: Tue, 12 Dec 2023 11:27:18 +0000 [thread overview]
Message-ID: <m2h6kn8xux.fsf@gmail.com> (raw)
In-Reply-To: <20231211152806.42a5323b@kernel.org> (Jakub Kicinski's message of "Mon, 11 Dec 2023 15:28:06 -0800")
Jakub Kicinski <kuba@kernel.org> writes:
> On Mon, 11 Dec 2023 16:40:29 +0000 Donald Hunter wrote:
>> The generated .rst for attribute-sets currently uses a sub-sub-heading
>> for each individual attribute. Change this to use a bullet list the
>> attributes in an attribute-set. It is more compact and readable.
>
> This is on purpose, we want to be able to link to the attributes.
> And AFAIU we can only link to headings.
>
> The documentation for attrs is currently a bit sparse so the docs
> end up looking awkward. But that's a problem with people not writing
> enough doc comments, not with the render, innit? :(
Okay, then I think we need to try and improve the formatting. Currently
h3 and h4 both have font-size: 130% and the attribute headings get
rendered in bold so they stand out more than the attribute-set headings
they are under. I suggest:
- Removing the bold markup from the attribute headings
- Changing h4 to font-size: 110% in sphinx-static/custom.css
That improves things a bit but I feel that the attribute-set headings
still get a bit lost. Not sure if there is anything we can do about
that. The devlink spec is a fairly extreme example because it has a lot
of subset definitions that look especially bleak.
next prev parent reply other threads:[~2023-12-12 11:42 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-11 16:40 [PATCH net-next v2 00/11] tools/net/ynl: Add 'sub-message' support to ynl Donald Hunter
2023-12-11 16:40 ` [PATCH net-next v2 01/11] tools/net/ynl-gen-rst: Use bullet lists for attribute-set entries Donald Hunter
2023-12-11 23:28 ` Jakub Kicinski
2023-12-12 11:27 ` Donald Hunter [this message]
2023-12-12 16:11 ` Jakub Kicinski
2023-12-11 16:40 ` [PATCH net-next v2 02/11] tools/net/ynl-gen-rst: Sort the index of generated netlink specs Donald Hunter
2023-12-11 23:30 ` Jakub Kicinski
2023-12-12 11:30 ` Donald Hunter
2023-12-12 16:13 ` Jakub Kicinski
2023-12-12 20:42 ` Breno Leitao
2023-12-11 16:40 ` [PATCH net-next v2 03/11] doc/netlink: Regenerate netlink .rst files if ynl-gen-rst changes Donald Hunter
2023-12-11 23:30 ` Jakub Kicinski
2023-12-12 20:39 ` Breno Leitao
2023-12-12 21:48 ` Donald Hunter
2023-12-11 16:40 ` [PATCH net-next v2 04/11] tools/net/ynl: Use consistent array index expression formatting Donald Hunter
2023-12-11 23:30 ` Jakub Kicinski
2023-12-11 16:40 ` [PATCH net-next v2 05/11] doc/netlink: Add sub-message support to netlink-raw Donald Hunter
2023-12-11 23:37 ` Jakub Kicinski
2023-12-12 11:30 ` Donald Hunter
2023-12-11 16:40 ` [PATCH net-next v2 06/11] doc/netlink: Document the sub-message format for netlink-raw Donald Hunter
2023-12-12 1:56 ` Jakub Kicinski
2023-12-12 11:32 ` Donald Hunter
2023-12-11 16:40 ` [PATCH net-next v2 07/11] tools/net/ynl: Add 'sub-message' attribute decoding to ynl Donald Hunter
2023-12-12 2:00 ` Jakub Kicinski
2023-12-11 16:40 ` [PATCH net-next v2 08/11] tools/net/ynl: Add binary and pad support to structs for tc Donald Hunter
2023-12-12 2:04 ` Jakub Kicinski
2023-12-12 11:36 ` Donald Hunter
2023-12-11 16:40 ` [PATCH net-next v2 09/11] doc/netlink/specs: add sub-message type to rt_link family Donald Hunter
2023-12-11 16:40 ` [PATCH net-next v2 10/11] doc/netlink/specs: Add a spec for tc Donald Hunter
2023-12-11 16:40 ` [PATCH net-next v2 11/11] tools/net/ynl-gen-rst: Add sub-messages to generated docs Donald Hunter
2023-12-12 20:42 ` Breno Leitao
2023-12-11 23:32 ` [PATCH net-next v2 00/11] tools/net/ynl: Add 'sub-message' support to ynl Jakub Kicinski
2023-12-12 11:38 ` Donald Hunter
2023-12-12 16:14 ` Jakub Kicinski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=m2h6kn8xux.fsf@gmail.com \
--to=donald.hunter@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=donald.hunter@redhat.com \
--cc=edumazet@google.com \
--cc=jacob.e.keller@intel.com \
--cc=kuba@kernel.org \
--cc=leitao@debian.org \
--cc=linux-doc@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).