From: Greg KH <greg@kroah.com>
To: Alan Stern <stern@rowland.harvard.edu>
Cc: Mayuresh Kulkarni <mkulkarni@opensource.cirrus.com>,
USB list <linux-usb@vger.kernel.org>
Subject: Re: [RFC] usbfs: Add ioctls for runtime suspend and resume
Date: Thu, 25 Jul 2019 18:05:21 +0200 [thread overview]
Message-ID: <20190725160521.GA8015@kroah.com> (raw)
In-Reply-To: <Pine.LNX.4.44L0.1907251112390.1343-100000@iolanthe.rowland.org>
On Thu, Jul 25, 2019 at 11:18:09AM -0400, Alan Stern wrote:
> On Thu, 25 Jul 2019, Greg KH wrote:
>
> > > > Still to do: Write up the documentation.??In fact, the existing
> > > > description of usbfs in Documentation/driver-api/usb/usb.rst is sadly
> > > > out of date.??And it deserves to be split out into a separate file of
> > > > its own -- but I'm not sure where it really belongs, considering that
> > > > it is an API for userspace, not an internal kernel API.
> > > >
> > > > Greg, suggestions?
> > >
> > > Hi Greg,
> > >
> > > Did you got a chance to look into the above documentation query by Alan?
> > > How should we go about documenting these new IOCTLs?
> >
> > Not yet, sorry, dealing with the backlog of patches after the merge
> > window closed.
> >
> > Give me a week or so...
> >
> > But if you want to try your hand at it first, it's always easier to
> > review a patch than it is to come up with a new one.
>
> Would Documentation/userspace-api/ be the right place to put this
> information? It looks like we could take a large chunk of
> driver-api/usb/usb.rst (most of it, in fact) and move it over there.
Sounds reasonable.
> By the way, do you know anything about how the information in
> Documentation/userspace-api gets presented to users in general? Is
> there anything comparable to the Linux man-pages project? Or are
> people just supposed to get hold of the kernel source from somewhere
> and read the files there?
No idea, but we do build it on every kernel release and put it up on
kernel.org to be easily indexed by search engines:
https://www.kernel.org/doc/html/latest/userspace-api/index.html
thanks,
greg k-h
next prev parent reply other threads:[~2019-07-25 16:05 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-10 10:01 [PATCH] usb: core: devio: add ioctls for suspend and resume Mayuresh Kulkarni
2019-06-05 9:41 ` Greg KH
2019-06-05 21:02 ` Alan Stern
2019-06-13 14:00 ` Mayuresh Kulkarni
2019-06-13 20:54 ` Alan Stern
2019-06-17 11:38 ` Mayuresh Kulkarni
2019-06-17 15:55 ` Alan Stern
2019-06-18 14:00 ` Mayuresh Kulkarni
2019-06-18 15:50 ` Alan Stern
2019-06-19 9:19 ` Oliver Neukum
2019-06-19 14:40 ` Alan Stern
2019-06-19 15:12 ` Oliver Neukum
2019-06-19 16:07 ` Alan Stern
2019-06-20 15:11 ` Mayuresh Kulkarni
2019-06-20 15:49 ` Alan Stern
2019-06-21 16:16 ` Mayuresh Kulkarni
2019-06-21 19:28 ` Alan Stern
2019-06-24 16:02 ` Mayuresh Kulkarni
2019-06-24 17:48 ` Alan Stern
2019-06-25 10:41 ` Mayuresh Kulkarni
2019-06-25 14:08 ` Alan Stern
2019-06-26 7:42 ` Oliver Neukum
2019-06-26 14:35 ` Alan Stern
2019-06-26 14:15 ` Mayuresh Kulkarni
2019-06-26 15:07 ` Alan Stern
2019-06-27 13:20 ` Mayuresh Kulkarni
2019-06-27 13:52 ` Alan Stern
2019-07-01 9:18 ` Oliver Neukum
2019-07-01 14:17 ` Alan Stern
2019-07-02 9:21 ` Oliver Neukum
2019-07-02 14:29 ` Alan Stern
2019-07-03 14:44 ` Mayuresh Kulkarni
2019-07-05 18:51 ` [RFC] usbfs: Add ioctls for runtime " Alan Stern
2019-07-11 9:16 ` Mayuresh Kulkarni
2019-07-11 14:20 ` Alan Stern
2019-07-11 14:36 ` Greg KH
2019-07-25 9:10 ` Mayuresh Kulkarni
2019-07-25 9:18 ` Greg KH
2019-07-25 15:18 ` Alan Stern
2019-07-25 16:05 ` Greg KH [this message]
2019-06-20 14:34 ` [PATCH] usb: core: devio: add ioctls for " Mayuresh Kulkarni
2019-06-20 14:43 ` Alan Stern
2019-06-13 13:32 ` Mayuresh Kulkarni
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=20190725160521.GA8015@kroah.com \
--to=greg@kroah.com \
--cc=linux-usb@vger.kernel.org \
--cc=mkulkarni@opensource.cirrus.com \
--cc=stern@rowland.harvard.edu \
/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;
as well as URLs for NNTP newsgroup(s).