mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "Lin Ma" <linma@zju.edu.cn>
To: "Simon Horman" <horms@kernel.org>
Cc: corbet@lwn.net, davem@davemloft.net, edumazet@google.com,
	kuba@kernel.org, pabeni@redhat.com, rdunlap@infradead.org,
	void@manifault.com, jani.nikula@intel.com,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	netdev@vger.kernel.org
Subject: Re: [PATCH v2] docs: staging: add netlink attrs best practices
Date: Fri, 11 Aug 2023 00:02:24 +0800 (GMT+08:00)	[thread overview]
Message-ID: <41722e43.1049b3.189e02f50f6.Coremail.linma@zju.edu.cn> (raw)
In-Reply-To: <ZNTw+ApPS9U4VhZI@vergenet.net>

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@zju.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

  parent reply	other threads:[~2023-08-10 16:21 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-09  3:25 Lin Ma
2023-08-10 14:15 ` Simon Horman
2023-08-10 15:34   ` Randy Dunlap
2023-08-10 16:06     ` Lin Ma
2023-08-10 16:02   ` Lin Ma [this message]
2023-08-11  9:53     ` Simon Horman

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=41722e43.1049b3.189e02f50f6.Coremail.linma@zju.edu.cn \
    --to=linma@zju.edu.cn \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=horms@kernel.org \
    --cc=jani.nikula@intel.com \
    --cc=kuba@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=rdunlap@infradead.org \
    --cc=void@manifault.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

all inboxes | Powered by JetHome®