James Smart wrote: > Randy, > > Thanks. Looks like we have this mistake in quite a few places. > > Any issue if we proceed with this patch set as is, and I'll turn around > and issue another set that addresses the kernel-doc style explicitly ? That's OK with me if it's done soon. > -- james s > > > Randy Dunlap wrote: >> James Smart wrote: >>> lpfc 8.3.0 : Add kernel-doc function headers to lpfc_scsi.c >>> >>> Add kernel-doc function headers to lpfc_scsi.c >>> >> >> Hi James, >> >> kernel-doc is a small language, with a small bit of syntax. It's >> documented >> in Documentation/kernel-doc-nano-HOWTO.txt. >> >> I say this because all of the first lines (function name/short >> description) >> use : instead of - to separate the name from the description. >> Please fix those. >> >> Also, the function name/short description can only be one line, so >> either make >> it > 80 characters if needed, or use this format: >> >> /** >> * lpfc_snaz - do some snazzy stuff >> * @hba: the target hba >> * >> * lpfc_snaz does some cool stuff and some hot stuff, such as- >> * - system snapshot to hba memory >> * - system check for infections and intrusions >> * - starts the coffee maker >> **/ -- To unsubscribe from this list: send the line "unsubscribe linux-scsi" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
