Subject: Re: [PATCH] Add lib/parser.c kernel-doc
From: Will Dyson <will_dyson@pobox.com>
To: Matthew Wilcox <willy@debian.org>
Cc: linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org
In-Reply-To: <20031116160958.GW30485@parcelfarce.linux.theplanet.co.uk>
References: <1068970562.19499.11.camel@thalience>
	 <20031116160958.GW30485@parcelfarce.linux.theplanet.co.uk>
Content-Type: text/plain
Message-Id: <1069021262.19499.55.camel@thalience>
Mime-Version: 1.0
Date: Sun, 16 Nov 2003 17:21:02 -0500
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 876
Lines: 24

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@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/