linux-kernel - Re: [PATCH] ipwireless: driver for 3G PC Card

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Tue, 29 Jan 2008 14:42:08 +0100
From:	David Sterba <dsterba@...e.cz>
To:	Jiri Slaby <jirislaby@...il.com>
Cc:	Randy Dunlap <rdunlap@...otime.net>, torvalds@...ux-foundation.org,
	linux-kernel@...r.kernel.org, jkosina@...e.cz,
	benm@...metric.co.nz, stephen@...metric.co.nz
Subject: Re: [PATCH] ipwireless: driver for 3G PC Card

On Tuesday 29 of January 2008 00:18:03 Jiri Slaby wrote:
> On 01/28/2008 07:08 PM, Randy Dunlap wrote:
> >> +/*
> >> + * @return 1 if something has been received from hw
> >
> > What's with the '@'?
>
> ...
>
> >> +
> >> +/*!
> >
> > and the '!' ?
> >
> >> + * @return true if the card is physically present.
> >> + */
>
> What exactly is wrong with @ and !? It's perfectly doxygen-styled.

Well, I've removed them, this was not consistent neither within the driver nor 
with kernel documenting style.

> >> diff --git a/drivers/char/pcmcia/ipwireless/main.c
> >> b/drivers/char/pcmcia/ipwireless/main.c new file mode 100644
> >> index 0000000..cab5722
> >> --- /dev/null
> >> +++ b/drivers/char/pcmcia/ipwireless/main.c
> >> @@ -0,0 +1,496 @@
>
> [...]
>
> >> +module_param(major, int, 0);
> >> +module_param(ipwireless_debug, int, 0);
> >> +module_param(ipwireless_loopback, int, 0);
> >> +module_param(ipwireless_out_queue, int, 0);
> >> +MODULE_PARM_DESC(major, "ttyIPWp major number [0]");
> >> +MODULE_PARM_DESC(ipwireless_debug, "switch on debug messages [0]");
> >> +MODULE_PARM_DESC(ipwireless_debug, "switch on loopback mode [0]");
> >> +MODULE_PARM_DESC(ipwireless_debug, "set size of outgoing queue [1]");
> >
> > Will these parameters be documented anywhere?
>
> Anyway the descs are wrong. Those 3 are for the only one variable.

Yes this was my copy&paste error, thanks.

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