Re: [PATCH v2 2/2] docs-rst: userspace: update verbs API details

2019-01-16 Thread Joel Nider
Jonathan Corbet wrote on 01/15/2019 11:38:59 PM: > We are not attempting to duplicate the man pages; there's been occasional > talk of bringing them into the kernel tree, but enthusiasm for that is > scarce for a number of good reasons. But there's a lot of information > about the user-space

Re: [PATCH v2 2/2] docs-rst: userspace: update verbs API details

2019-01-16 Thread Mike Rapoport
Hi Jon, On Tue, Jan 15, 2019 at 02:38:59PM -0700, Jonathan Corbet wrote: > On Tue, 15 Jan 2019 22:37:01 +0200 > > I'd rather see you put the new stuff under Documentation/driver-api, either > in a standalone file or in a new subdirectory. > > Thanks for your patience with this! We really do

Re: [PATCH v2 2/2] docs-rst: userspace: update verbs API details

2019-01-15 Thread Jonathan Corbet
On Tue, 15 Jan 2019 22:37:01 +0200 "Joel Nider" wrote: > Jonathan Corbet wrote on 01/15/2019 08:08:54 PM: > > The intent behind the user-space API manual is to document the user-space > > API; it's meant to be read by people writing applications and such. > > Perhaps they find it with a web

Re: [PATCH v2 2/2] docs-rst: userspace: update verbs API details

2019-01-15 Thread Joel Nider
/2019 08:09 PM > Subject: Re: [PATCH v2 2/2] docs-rst: userspace: update verbs API details > > On Tue, 15 Jan 2019 18:29:59 +0200 > "Joel Nider" wrote: > > > > I think this is a horrible direction to take. The current document is > > > clearly for _us

Re: [PATCH v2 2/2] docs-rst: userspace: update verbs API details

2019-01-15 Thread Jonathan Corbet
On Tue, 15 Jan 2019 18:29:59 +0200 "Joel Nider" wrote: > > 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. > > > Hmm,

Re: [PATCH v2 2/2] docs-rst: userspace: update verbs API details

2019-01-15 Thread Joel Nider
; Subject: Re: [PATCH v2 2/2] docs-rst: userspace: update verbs API details > > 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 i

Re: [PATCH v2 2/2] docs-rst: userspace: update verbs API details

2019-01-15 Thread Matthew Wilcox
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.

[PATCH v2 2/2] docs-rst: userspace: update verbs API details

2019-01-15 Thread Joel Nider
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