Re: trivial: make comment about vs{n,cn,}printf more understandable

[Will Schmidt]

On Tue, 2010-11-23 at 22:20 -0500, Steven Rostedt wrote:
> On Tue, 2010-11-23 at 21:04 -0600, Milton Miller wrote:
> > On Tue, 23 Nov 2010 at about 16:12:45 -0000, Uwe Kleine-KÃnig wrote:
> > > 
> > > "You probably want ... instead." sounds like a recommendation better
> > > not to use the v... functions.
> > > 
> > 
> > Which is true, if you dont' have a va_list its hard to get them.
> > But I do get your point.
> > 
> > >   * the @buf not including the trailing '\0'. If @size is <= 0 the function
> > >   * returns 0.
> > >   *
> > > - * Call this function if you are already dealing with a va_list.
> > > - * You probably want scnprintf() instead.
> > > + * If you're not already dealing with a va_list better use scnprintf().
> > 
> > That doesn't flow off my (mid-western usa) tounge.
> > 
> > How about
> >  * Call this function if you are already dealing with a va_list.
> >  * Otherwise you probably want to use scnprintf().

> This is closer to what he asked us on IRC ;-)
> 
> But a "do X if Y" is more perl syntax than English (IMHO).
> 
> 
> > 
> > Alternatively,
> >  * If you're not already dealing with a va_list consider scnprintf().
> 
> This isn't bad. My recommendation I gave him was:
> 
>  * If you are already dealing with a va_list, then call this function.
>  * Otherwise you probably want to use scnprintf()

Would be nice if we could lead with the "probably...", but I don't see a
clean way of doing that.    How about a blending of the two:

 * Call this function if you are dealing with a va_list, otherwise use
the scnprintf() function.


> But my upstate NY tongue may not be the best judgment here.
> 
> -- Steve
> 
> "When people ask me what language my mother tongue is, I simply reply 'C'"
> 
> 
> 


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