On Wed, Feb 05, 2014 at 03:54:17PM -0800, James Bottomley wrote: > > -/* > > - * Function: scsi_run_queue() > > - * > > - * Purpose: Select a proper request queue to serve next > > - * > > - * Arguments: q - last request's queue > > - * > > - * Returns: Nothing > > - * > > - * Notes: The previous command was completely finished, start > > - * a new one if possible. > > - */ > > Instead of dumping the description, how about converting it to docbook > and making it match the new function?
I dropped it because there's nothing that isn't trivially obvious from the code. The point of comments should be to explain why things are done and not have a redundant writeup of what is done. Docbook comments make sense for exported functions but not so much for a static function with a handful of callers. -- To unsubscribe from this list: send the line "unsubscribe linux-scsi" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
