public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Will Dyson <will_dyson@pobox.com>
To: Matthew Wilcox <willy@debian.org>
Cc: linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Add lib/parser.c kernel-doc
Date: Sun, 16 Nov 2003 17:21:02 -0500	[thread overview]
Message-ID: <1069021262.19499.55.camel@thalience> (raw)
In-Reply-To: <20031116160958.GW30485@parcelfarce.linux.theplanet.co.uk>

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


  parent reply	other threads:[~2003-11-16 22:21 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2003-11-16  8:16 [PATCH] Add lib/parser.c kernel-doc Will Dyson
2003-11-16 16:09 ` Matthew Wilcox
2003-11-16 18:20   ` Jamie Lokier
2003-11-16 18:33     ` viro
2003-11-16 22:21   ` Will Dyson [this message]
2003-11-16 22:37 ` Will Dyson
2003-11-17  7:28   ` Jan-Benedict Glaw
2003-11-17  9:29     ` Will Dyson
2003-11-17 16:55       ` Randy.Dunlap
2003-11-17 19:38         ` Pat LaVarre
2003-11-18  5:10           ` Will Dyson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1069021262.19499.55.camel@thalience \
    --to=will_dyson@pobox.com \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=willy@debian.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox