From: Matthew Wilcox <willy@infradead.org>
To: Joel Nider <joeln@il.ibm.com>
Cc: Jonathan Corbet <corbet@lwn.net>, Jason Gunthorpe <jgg@ziepe.ca>,
Leon Romanovsky <leon@kernel.org>,
Doug Ledford <dledford@redhat.com>,
Mike Rapoport <rppt@linux.ibm.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 2/2] docs-rst: userspace: update verbs API details
Date: Tue, 15 Jan 2019 07:31:28 -0800 [thread overview]
Message-ID: <20190115153128.GA6310@bombadil.infradead.org> (raw)
In-Reply-To: <1547547991-5314-3-git-send-email-joeln@il.ibm.com>
On Tue, Jan 15, 2019 at 12:26:31PM +0200, Joel Nider wrote:
> It is important to understand the existing framework when implementing
> a new verb. The majority of existing API functions are implemented using
> the write syscall, but this has been superceded by the ioctl syscall
> for new commands. This patch updates the documentation regarding how
> to go about implementing a new verb, focusing on the new ioctl
> interface.
>
> The documentation is far from complete, but this is a good step in the
> right direction. Future patches can add more detail according to need.
> Also, the interface is still undergoing substantial changes so an
> effort was made to document only the stable parts so as to avoid
> incorrect information since documentation changes tend to lag behind
> code changes.
I think this is a horrible direction to take. The current document is
clearly for _users_. All this documentation you've added is for kernel
hackers. It needs to go in a different file, or not be added at all.
next prev parent reply other threads:[~2019-01-15 15:31 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-15 10:26 docs-rst: update infiniband uverbs doc Joel Nider
2019-01-15 10:26 ` [PATCH v2 1/2] docs-rst: Convert user verbs doc to rst Joel Nider
2019-01-15 15:14 ` Jason Gunthorpe
2019-01-15 18:02 ` Jonathan Corbet
2019-01-15 20:41 ` Joel Nider
2019-01-15 10:26 ` [PATCH v2 2/2] docs-rst: userspace: update verbs API details Joel Nider
2019-01-15 15:31 ` Matthew Wilcox [this message]
2019-01-15 16:29 ` Joel Nider
2019-01-15 18:08 ` Jonathan Corbet
2019-01-15 20:37 ` Joel Nider
2019-01-15 21:38 ` Jonathan Corbet
2019-01-17 0:06 ` Mike Rapoport
2019-01-17 6:33 ` Joel Nider
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=20190115153128.GA6310@bombadil.infradead.org \
--to=willy@infradead.org \
--cc=corbet@lwn.net \
--cc=dledford@redhat.com \
--cc=jgg@ziepe.ca \
--cc=joeln@il.ibm.com \
--cc=leon@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rppt@linux.ibm.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