From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8BC0EC76194 for ; Thu, 25 Jul 2019 15:18:11 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 6F24122BF5 for ; Thu, 25 Jul 2019 15:18:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2389020AbfGYPSK (ORCPT ); Thu, 25 Jul 2019 11:18:10 -0400 Received: from iolanthe.rowland.org ([192.131.102.54]:39460 "HELO iolanthe.rowland.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with SMTP id S2388457AbfGYPSK (ORCPT ); Thu, 25 Jul 2019 11:18:10 -0400 Received: (qmail 1410 invoked by uid 2102); 25 Jul 2019 11:18:09 -0400 Received: from localhost (sendmail-bs@127.0.0.1) by localhost with SMTP; 25 Jul 2019 11:18:09 -0400 Date: Thu, 25 Jul 2019 11:18:09 -0400 (EDT) From: Alan Stern X-X-Sender: stern@iolanthe.rowland.org To: Greg KH cc: Mayuresh Kulkarni , USB list Subject: Re: [RFC] usbfs: Add ioctls for runtime suspend and resume In-Reply-To: <20190725091844.GA18907@kroah.com> Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=UTF-8 Content-Transfer-Encoding: 8BIT Sender: linux-usb-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-usb@vger.kernel.org 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. 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? Alan Stern