Messages in this thread | | | Date | Mon, 18 Jun 2007 15:11:57 +0200 | From | Sam Ravnborg <> | Subject | Re: [RFC/PATCH] Documentation of kernel messages |
| |
On Fri, Jun 15, 2007 at 11:42:15AM -0700, Gerrit Huizenga wrote: > > Andrew mentioned a mechanism for adding a subsystem tag or other tag > which helps disambiguate the message, either in the message file or in > the end user documentation (e.g. the Message Pedia/mPedia that the Japanese > have already created with ~350 messages, and a total of ~700 targetted > by the end of the year). > > That tag could be appended to the beginning of the printk, to the end of > the printk, or even in a formatted comment at the end of the printk that > the tool could extract.
The best way to maintain such a subsystem tag most be supported by kbuild. So say we have the subsystem "scsi" then we can set this subsystem tag in drivers/scsi/Makefile and let drivers/scsi/arm/Makefile inherit this vaule doing nothing.
Addign the subsystem tag to the printk could than be done using the C preprocessor and we are all fine.
If we go by the kernel-doc way to document kernel messages (the few that actually needs additional explanation) then we need to teach kernel-doc to collect the same subsystem tag but that should be doable.
Sam - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |