]> git.hungrycats.org Git - linux/commit
[PATCH] USB storage: Add comments explaining new s-g usage
authorAlan Stern <stern@rowland.harvard.edu>
Tue, 9 Dec 2003 03:48:52 +0000 (19:48 -0800)
committerGreg Kroah-Hartman <greg@kroah.com>
Tue, 9 Dec 2003 03:48:52 +0000 (19:48 -0800)
commit343f4be5136012a42777308e5bf11026d3cb9365
tree1aae2a226cf1f8001841489963aeea335c26c72f
parent15a600075d707013f409d4cb92e8cea0023bf251
[PATCH] USB storage: Add comments explaining new s-g usage

On Sun, 30 Nov 2003, Matthew Dharm wrote:
> I'm going to pass this one along to Greg, but I think some places in this
> could really use some better comments.  Especially the way you use a single
> buffer inside the loop -- it took me a few minutes to figure out how your
> logic to refresh the buffer with new data worked.
>
> I'm also wondering if the access_xfer_buf() function could use some more
> header comments, stating why this is needed (i.e. spelling out the
> kmap()-isms).

Okay, here it is.  This patch basically just adds comments.  Each routine
that uses the new scatter-gather function gets a brief explanation of
what's going on, and access_xfer_buf() itself gets detailed comments
saying what it's doing and why it's necessary.  You may even want to cut
some of it back; I was pretty verbose.
drivers/usb/storage/datafab.c
drivers/usb/storage/jumpshot.c
drivers/usb/storage/protocol.c
drivers/usb/storage/sddr09.c
drivers/usb/storage/sddr55.c
drivers/usb/storage/shuttle_usbat.c