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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <41722e43.1049b3.189e02f50f6.Coremail.linma@zju.edu.cn>
Date: Fri, 11 Aug 2023 00:02:24 +0800 (GMT+08:00)
From: "Lin Ma" <linma@....edu.cn>
To: "Simon Horman" <horms@...nel.org>
Cc: corbet@....net, davem@...emloft.net, edumazet@...gle.com, 
	kuba@...nel.org, pabeni@...hat.com, rdunlap@...radead.org, 
	void@...ifault.com, jani.nikula@...el.com, linux-doc@...r.kernel.org, 
	linux-kernel@...r.kernel.org, netdev@...r.kernel.org
Subject: Re: [PATCH v2] docs: staging: add netlink attrs best practices

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@....edu.cn>
> 
> 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