Re: [PATCH 5/5] Add DMA engine driver for Freescale MPC85xx processors.

From: Randy Dunlap
Date: Tue Sep 11 2007 - 10:21:55 EST


Zhang Wei-r63237 wrote:

+/**
+ * fsl_chan_xfer_ld_queue -- Transfer the link descriptors
in channel
+ * ld_queue.
The function's "short description" (unfortunately) must be on only one
line. E.g.:

* fsl_chan_xfer_ld_queue - Transfer link descriptors in channel ld_queue.


How about it's length greater than 80?

If it's close to 80+, you can just leave it like that.
If it's much longer, you can use this format:

/**
* function_name - short description
* @parameters: prm description
*
* Longer
* function
* description.
*/



Thanks,
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/