Re: [PATCH] netlink: specs: add specification for NBD
- To: Hristo Venev <hristo@venev.name>
- Cc: Donald Hunter <donald.hunter@gmail.com>, Jakub Kicinski <kuba@kernel.org>, "David S. Miller" <davem@davemloft.net>, Eric Dumazet <edumazet@google.com>, Paolo Abeni <pabeni@redhat.com>, Simon Horman <horms@kernel.org>, netdev@vger.kernel.org, Josef Bacik <josef@toxicpanda.com>, Jens Axboe <axboe@kernel.dk>, linux-block@vger.kernel.org, nbd@other.debian.org
- Subject: Re: [PATCH] netlink: specs: add specification for NBD
- From: Wouter Verhelst <w@uter.be>
- Date: Mon, 23 Feb 2026 11:40:26 +0200
- Message-id: <[🔎] aZwgiv0vPWPybUF-@pc220518.home.grep.be>
- In-reply-to: <[🔎] 6a1339999b091edaaa15e34aceb7961dfc61581b.camel@venev.name>
- References: <[🔎] 20260215180309.2255721-3-hristo@venev.name> <[🔎] m2o6lnlg2y.fsf@gmail.com> <[🔎] 6a1339999b091edaaa15e34aceb7961dfc61581b.camel@venev.name>
On Tue, Feb 17, 2026 at 07:40:33PM +0200, Hristo Venev wrote:
> On Tue, 2026-02-17 at 12:17 +0000, Donald Hunter wrote:
> > There are yamllint errors:
> >
> > make -C tools/net/ynl lint
> > make: Entering directory '/home/donaldh/net-next/tools/net/ynl'
> > yamllint ../../../Documentation/netlink/specs
> > ../../../Documentation/netlink/specs/nbd.yaml
> > 159:81 error line too long (104 > 80 characters) (line-
> > length)
> > 169:6 error syntax error: expected <block end>, but found
> > '<block mapping start>' (syntax)
> > 170:7 error wrong indentation: expected 5 but found 6
> > (indentation)
>
> Thanks, I will fix the lint errors in v2.
>
> > > +doc: See :file:`drivers/block/nbd.c`
> >
> > Prefer to see a meaningful doc string here.
>
> I will add more proper documentation in v2. I couldn't find any
> existing documentation of this netlink interface, so I guess I will
> write it myself.
As luck would have it, before I saw this message, I had been wanting to
work on some of the messages that nbd-client still needed, and so I
asked an LLM to analyze the code and generate some docs for me.
Heed the "LLM" part. It's probably not perfect. But it could be a good
starting point. Or not. At any rate, you can find it here:
https://github.com/NetworkBlockDevice/nbd/blob/master/doc/netlink-proto.md
--
"I never had a C in history!"
"Yeah, but there was so much less of it when you were my age!"
-- Joe Brockmeier recounting a conversation with his father, cfgmgmtcamp 2026, Ghent
Reply to: