On Mon, 4 Dec 2006, roland wrote: > Hello Alan, > > thanks for your feedback! > > just one additional question: > > any reason, why there is lot`s of documentation about g_file_storage in > > ./drivers/usb/gadget/file_storage.c > > but not in > > ./Documentation/usb/.... > > ? > > it seems, g_file_storage isn`t even mentioned there. > > imho, this makes it difficult for "end users" to find such useful features > ( i really had a hard time finding it) > > if there is no special reason that the docs is only with the source, what > about moving docs to Documentation/usb and just > putting copyright information and a reference into the source (or > vice-versa, at least some reference from Documentation/usb) ? > > there is so damn lots of useful stuff inside the linux kernel, but often > nowbody knows about.....
You're right, there was no special reason for putting the documentation into the source code. It could be moved to the Documentation/usb directory. The reasons for doing it this way were: (1) It's easier for the programmer (me) writing the driver to have the documentation right there along with the code, and (2) I never thought of it. Most of the files under Documentation/usb are pretty old and out of date, with only a few useful exceptions. There is no clear convention in Linux for deciding where documentation belongs. Can you imagine the mess if _every_ driver in the kernel had its own separate file under Documentation? Anyway, once you know that the driver exists, it won't take you long to find the documentation in either location. And the existence of g_file_storage _is_ documented on the www.linux-usb.org web site, so end users do have a reasonable way to find out about it. Bear in mind also, that most users will never care about g_file_storage or have a reason for using it. Alan Stern ------------------------------------------------------------------------- Take Surveys. Earn Cash. Influence the Future of IT Join SourceForge.net's Techsay panel and you'll get the chance to share your opinions on IT & business topics through brief surveys - and earn cash http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV _______________________________________________ Linux-usb-users@lists.sourceforge.net To unsubscribe, use the last form field at: https://lists.sourceforge.net/lists/listinfo/linux-usb-users
