All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Jakub Kicinski <kuba@kernel.org>, davem@davemloft.net
Cc: netdev@vger.kernel.org, edumazet@google.com, pabeni@redhat.com,
	Jakub Kicinski <kuba@kernel.org>,
	Jacob Keller <jacob.e.keller@intel.com>,
	johannes@sipsolutions.net, stephen@networkplumber.org,
	sdf@google.com, ecree.xilinx@gmail.com,
	benjamin.poirier@gmail.com, idosch@idosch.org,
	f.fainelli@gmail.com, jiri@resnulli.us, dsahern@kernel.org,
	fw@strlen.de, linux-doc@vger.kernel.org, jhs@mojatatu.com,
	tgraf@suug.ch, svinota.saveliev@gmail.com, rdunlap@infradead.org,
	mkubecek@suse.cz
Subject: Re: [PATCH v2 2/2] docs: netlink: basic introduction to Netlink
Date: Fri, 19 Aug 2022 14:54:48 -0600	[thread overview]
Message-ID: <874jy89co7.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220819200221.422801-2-kuba@kernel.org>

Jakub Kicinski <kuba@kernel.org> writes:

> Provide a bit of a brain dump of netlink related information
> as documentation. Hopefully this will be useful to people
> trying to navigate implementing YAML based parsing in languages
> we won't be able to help with.
>
> I started writing this doc while trying to figure out what
> it'd take to widen the applicability of YAML to good old rtnl,
> but the doc grew beyond that as it usually happens.
>
> In all honesty a lot of this information is new to me as I usually
> follow the "copy an existing example, drink to forget" process
> of writing netlink user space, so reviews will be much appreciated.
>
> Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> --
> Jon, I'm putting this in userspace-api/ I think it fits reasonably
> well there but please don't hesitate to suggest a better home.

That seems like a fine place for it - this is an addition that, I think,
a lot of people will welcome.

A couple of nits, feel free to ignore them:

 - Do you plan to add other netlink documents to that directory in the
   future?  If not, I'd just make a netlink.rst and not bother with the
   directory and index.rst.

 - I'm not sure that all the :c:member markup buys enough to be worth
   the clutter.

Regardless, should it be worth something:

Acked-by: Jonathan Corbet <corbet@lwn.net>

Thanks for doing this; I've been meaning for years to reverse-engineer
netlink and write something like this, now I don't have to :)

jon

  reply	other threads:[~2022-08-19 20:55 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-19 20:02 [PATCH v2 1/2] net: improve and fix netlink kdoc Jakub Kicinski
2022-08-19 20:02 ` [PATCH v2 2/2] docs: netlink: basic introduction to Netlink Jakub Kicinski
2022-08-19 20:54   ` Jonathan Corbet [this message]
2022-08-19 23:17     ` Jakub Kicinski
2022-08-24  0:30 ` [PATCH v2 1/2] net: improve and fix netlink kdoc patchwork-bot+netdevbpf

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=874jy89co7.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=benjamin.poirier@gmail.com \
    --cc=davem@davemloft.net \
    --cc=dsahern@kernel.org \
    --cc=ecree.xilinx@gmail.com \
    --cc=edumazet@google.com \
    --cc=f.fainelli@gmail.com \
    --cc=fw@strlen.de \
    --cc=idosch@idosch.org \
    --cc=jacob.e.keller@intel.com \
    --cc=jhs@mojatatu.com \
    --cc=jiri@resnulli.us \
    --cc=johannes@sipsolutions.net \
    --cc=kuba@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=mkubecek@suse.cz \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=rdunlap@infradead.org \
    --cc=sdf@google.com \
    --cc=stephen@networkplumber.org \
    --cc=svinota.saveliev@gmail.com \
    --cc=tgraf@suug.ch \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.