Re: [PATCH] Add lib/parser.c kernel-doc

From: Will Dyson
Date: Sun Nov 16 2003 - 17:22:26 EST


On Sun, 2003-11-16 at 11:09, Matthew Wilcox wrote:

> > -int match_int(substring_t *, int *result);
> > +int match_int(substring_t *s, int *result);
>
> What value does this "s" add? "result" is clearly useful documentation,
> but "s" says "There is no good name for this variable"

True, but that is what it is named in the function definition. I'll try
to think of a good name for these, but I guess a documentation patch is
not the place for that (since I'd want to change it in both declaration
and definition).

Your other comments are well-taken as well.

--
Will Dyson
"Back off man, I'm a scientist!" -Dr. Peter Venkman

-
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/