Re: [PATCH v2] docs: staging: add netlink attrs best practices

From: Lin Ma
Date: Thu Aug 10 2023 - 12:21:13 EST


Hello Simon,

> > Provide some suggestions that who deal with Netlink code could follow
> > (of course using the word "best-practices" may sound somewhat
> > exaggerate).
> >
> > According to my recent practices, the parsing of the Netlink attributes
> > lacks documents for kernel developers. Since recently the relevant docs
> > for Netlink user space get replenished, I guess is a good chance for
> > kernel space part to catch with.
> >
> > First time to write a document and any reviews are appreciated.
> >
> > Signed-off-by: Lin Ma <linma@xxxxxxxxxx>
>
> Thanks for writing this up, from my perspective this is very useful.
>
> Some trivial feedback follows.

Thanks sooooooo much. And feel really sorry that the v2 still has so many
typos, grammar issues, and word misuse. I will prepare the v3 carefully
with all those suggestions. Really appreciate that.

>
> > ---
> > v1 -> v2: fix some typos in FOO example,
> > add extra section "About General Netlink Case" to avoid any
> > confusion for new code users.
> >
> > Documentation/staging/index.rst | 1 +
> > .../staging/netlink-attrs-best-practices.rst | 544 ++++++++++++++++++
> > MAINTAINERS | 1 +
>
> Perhaps this was discussed earlier.
> But I'm curious to know if there is a preference for putting
> this into staging rather than networking or elsewhere.
>

In fact, I have no idea about that. But since the current Netlink
documentation is mainly user space related so I can convince myself not
to put this document there.

I guess you are right, maybe I should place it at Documentation/networking/
folder.

[snip]

Thanks again
Lin