On Wed, 25 May 2011 18:49:40 +0200 Arend van Spriel wrote: > On 05/25/2011 06:43 PM, Randy Dunlap wrote: > > > >> diff --git a/lib/crc8.c b/lib/crc8.c > >> new file mode 100644 > >> index 0000000..0ce4238 > >> --- /dev/null > >> +++ b/lib/crc8.c > >> @@ -0,0 +1,84 @@ > >> +/* > >> + * Copyright (c) 2011 Broadcom Corporation > >> + * > >> + * Permission to use, copy, modify, and/or distribute this software for any > >> + * purpose with or without fee is hereby granted, provided that the above > >> + * copyright notice and this permission notice appear in all copies. > >> + * > >> + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES > >> + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF > >> + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY > >> + * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES > >> + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION > >> + * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN > >> + * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. > >> + */ > > insert blank line here, please. > > Will do that. > > >> +#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt > >> +#include<linux/module.h> > >> +#include<linux/crc8.h> > >> +#include<linux/printk.h> > >> + > >> +/* > >> + * crc8_populate_msb - fill crc table for given polynomial in reverse bit order. > >> + * > >> + * table: table to be filled. > >> + * polynomial: polynomial for which table is to be filled. > >> + */ > > Please convert all of these function comments to kernel-doc, like the header file has. > > Can be done easily, but what would be the added value to describe a > function twice. I am not fully aware of the usage of kernel-doc, but if > it were run over the full kernel tree I would expect the same function > to popup twice if I the kernel-doc markup to the source file as well. OK, never mind, then. Usually only one of the files is included in a docbook.tmpl file anyway (i.e., crc8.h or crc8.c). Only both would be included if they both contained something (new/different) to add to the documentation. --- ~Randy *** Remember to use Documentation/SubmitChecklist when testing your code *** -- To unsubscribe from this list: send the line "unsubscribe linux-wireless" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
